Home | History | Annotate | Line # | Download | only in external
README revision 1.11 
      1 $NetBSD: README,v 1.11 2010/10/24 19:23:22 christos 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 	bsd		BSD (or equivalent) licensed software, possibly with
     48 			the "advertising clause".
     49 			http://www.opensource.org/licenses/bsd-license.php
     50 
     51 	cddl		Common Development and Distribution License (the sun
     52 			license which is based on the Mozilla Public License
     53 			version 1.1).
     54 			http://www.opensource.org/licenses/cddl1.php
     55 
     56 	gpl2		GNU Public License, version 2 (or earlier).
     57 			http://www.opensource.org/licenses/gpl-2.0.php
     58 
     59 	gpl3		GNU Public License, version 3.
     60 			http://www.opensource.org/licenses/gpl-3.0.html
     61 
     62 	historical	Lucent's old license:
     63 			http://www.opensource.org/licenses/historical.php
     64 			
     65 	ibm-public	IBM's public license:
     66 			http://www.opensource.org/licenses/ibmpl.php
     67 
     68 	intel-fw-eula	Intel firmware license with redistribution
     69 			restricted to OEM.
     70 
     71 	intel-fw-public	Intel firmware license permitting redistribution with
     72 			terms similar to BSD licensed software.
     73 
     74 	intel-public	Intel license permitting redistribution with
     75 			terms similar to BSD licensed software.
     76 
     77 	mit		MIT (X11) style license.
     78 			http://www.opensource.org/licenses/mit-license.php
     79 
     80 	zlib		Zlib (BSD-like) licenes.
     81 			http://www.zlib.net/zlib_license.html
     82 
     83 If a package has components covered by different licenses
     84 (for example, GPL2 and the LGPL), use the <license> subdirectory
     85 for the more restrictive license.
     86 
     87 If a package allows the choice of a license to use, we'll
     88 generally use the less restrictive license.
     89 
     90 If in doubt about where a package should be located, please
     91 contact <core (a] NetBSD.org> for advice.
     92 
     93 
     94 Migration Strategy:
     95 
     96 
     97 Eventually src/dist (and associated framework in other base source
     98 directories) and src/gnu will be migrated to this hierarchy.
     99 
    100 
    101 Maintenance Strategy:
    102 
    103 The sources under src/external/<license>/<package>/dist/ are
    104 generally a combination of a published distribution plus changes
    105 that we submit to the maintainers and that are not yet published
    106 by them.
    107 
    108 Make sure all changes made to the external sources are submitted
    109 to the appropriate maintainer, but only after coordinating with
    110 the NetBSD maintainers.
    111