Home | History | Annotate | Line # | Download | only in external
README revision 1.7 
      1 $NetBSD: README,v 1.7 2009/08/18 21:30:31 wiz 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 	bsd		BSD (or equivalent) licensed software, possibly with
     45 			the "advertising clause".
     46 
     47 	gpl2		GNU Public License, version 2 (or earlier).
     48 
     49 	intel-fw-oem	Intel firmware license with redistribution
     50 			restricted to OEM.
     51 
     52 	intel-fw-public	Intel firmware license permitting redistribution with
     53 			terms similar to BSD licensed software.
     54 
     55 	intel-public	Intel license permitting redistribution with
     56 			terms similar to BSD licensed software.
     57 
     58 	mit		MIT (X11) style license.
     59 
     60 If a package has components covered by different licenses
     61 (for example, GPL2 and the LGPL), use the <license> subdirectory
     62 for the more restrictive license.
     63 
     64 If a package allows the choice of a license to use, we'll
     65 generally use the less restrictive license.
     66 
     67 If in doubt about where a package should be located, please
     68 contact <core (a] NetBSD.org> for advice.
     69 
     70 
     71 Migration Strategy:
     72 
     73 
     74 Eventually src/dist (and associated framework in other base source
     75 directories) and src/gnu will be migrated to this hierarchy.
     76 
     77 
     78 Maintenance Strategy:
     79 
     80 The sources under src/external/<license>/<package>/dist/ are
     81 generally a combination of a published distribution plus changes
     82 that we submit to the maintainers and that are not yet published
     83 by them.
     84 
     85 Make sure all changes made to the external sources are submitted
     86 to the appropriate maintainer, but only after coordinating with
     87 the NetBSD maintainers.
     88