Home | History | Annotate | Line # | Download | only in external
README revision 1.18 
      1 $NetBSD: README,v 1.18 2020/11/10 11:00:02 gson Exp $
      2 
      3 Organization of Sources:
      4 
      5 This directory hierarchy is using an organization that separates
      6 source for programs that we have obtained from external third
      7 parties (where NetBSD is not the primary maintainer) from the
      8 system source.
      9 
     10 The hierarchy is grouped by license, and then package per license,
     11 and is organized as follows:
     12 
     13 	external/
     14 
     15 	    Makefile
     16 			Descend into the license sub-directories.
     17 
     18 	    <license>/
     19 			Per-license sub-directories.
     20 
     21 		Makefile
     22 			Descend into the package sub-directories.
     23 
     24 		<package>/
     25 			Per-package sub-directories.
     26 
     27 		    Makefile
     28 			Build the package.
     29 
     30 		    dist/
     31 			The third-party source for a given package.
     32 
     33 		    bin/
     34 		    lib/
     35 		    sbin/
     36 			BSD makefiles "reach over" from these into
     37 			"../dist/".
     38 
     39 This arrangement allows for packages to be easily disabled or
     40 excised as necessary, either on a per-license or per-package basis.
     41 
     42 The licenses currently used are:
     43 
     44 	apache2		Apache 2.0 license.
     45 			http://www.opensource.org/licenses/apache2.0.php
     46 
     47 	atheros		Atheros License.
     48 
     49 	bsd		BSD (or equivalent) licensed software, possibly with
     50 			the "advertising clause".
     51 			http://www.opensource.org/licenses/bsd-license.php
     52 
     53 	cddl		Common Development and Distribution License (the sun
     54 			license which is based on the Mozilla Public License
     55 			version 1.1).
     56 			http://www.opensource.org/licenses/cddl1.php
     57 
     58 	gpl2		GNU Public License, version 2 (or earlier).
     59 			http://www.opensource.org/licenses/gpl-2.0.php
     60 
     61 	gpl3		GNU Public License, version 3.
     62 			http://www.opensource.org/licenses/gpl-3.0.html
     63 
     64 	historical	Lucent's old license:
     65 			http://www.opensource.org/licenses/historical.php
     66 
     67 	ibm-public	IBM's public license:
     68 			http://www.opensource.org/licenses/ibmpl.php
     69 
     70 	intel-fw-eula	Intel firmware license with redistribution
     71 			restricted to OEM.
     72 
     73 	intel-fw-public	Intel firmware license permitting redistribution with
     74 			terms similar to BSD licensed software.
     75 
     76 	intel-public	Intel license permitting redistribution with
     77 			terms similar to BSD licensed software.
     78 
     79 	mit		MIT (X11) style license.
     80 			http://www.opensource.org/licenses/mit-license.php
     81 
     82 	mpl		Mozilla Public license.
     83 			https://opensource.org/licenses/MPL-2.0
     84 
     85 	nvidia-firmware	NVIDIA firmware license permitting redistribution for
     86 			use on operating systems distributed under the terms
     87 			of an OSI-approved open source license.
     88 
     89 	public-domain	Non-license for code that has been explicitly put
     90 			into the Public Domain.
     91 
     92 	realtek		RealTek license.
     93 
     94 	zlib		Zlib (BSD-like) license.
     95 			http://www.zlib.net/zlib_license.html
     96 
     97 If a package has components covered by different licenses
     98 (for example, GPL2 and the LGPL), use the <license> subdirectory
     99 for the more restrictive license.
    100 
    101 If a package allows the choice of a license to use, we'll
    102 generally use the less restrictive license.
    103 
    104 If in doubt about where a package should be located, please
    105 contact <core (a] NetBSD.org> for advice.
    106 
    107 
    108 Migration Strategy:
    109 
    110 
    111 Eventually src/dist (and associated framework in other base source
    112 directories) and src/gnu will be migrated to this hierarchy.
    113 
    114 
    115 Maintenance Strategy:
    116 
    117 The sources under src/external/<license>/<package>/dist/ are
    118 generally a combination of a published distribution plus changes
    119 that we submit to the maintainers and that are not yet published
    120 by them.
    121 
    122 Make sure all changes made to the external sources are submitted
    123 to the appropriate maintainer, but only after coordinating with
    124 the NetBSD maintainers.
    125