Home | History | Annotate | Line # | Download | only in external
README revision 1.1 
      1 $NetBSD: README,v 1.1 2009/01/20 07:15:30 agc Exp $
      2 
      3 Organization of Sources:
      4 
      5 This directory hierarchy is using an organization that separates
      6 crypto source for programs that we have obtained from external third
      7 parties (where NetBSD is not the primary maintainer) from the system
      8 source.
      9 
     10 This README file is derived from the README file in src/external.
     11 
     12 The hierarchy is grouped by license, and then package per license,
     13 and is organized as follows:
     14 
     15 	external/
     16 
     17 	    Makefile
     18 			Descend into the license sub-directories.
     19 
     20 	    <license>/
     21 			Per-license sub-directories.
     22 
     23 		Makefile
     24 			Descend into the package sub-directories.
     25 
     26 		<package>/
     27 			Per-package sub-directories.
     28 
     29 		    Makefile
     30 			Build the package.
     31 			
     32 		    dist/
     33 			The third-party source for a given package.
     34 
     35 		    bin/
     36 		    lib/
     37 		    sbin/
     38 			BSD makefiles "reach over" from these into
     39 			"../dist/".
     40 
     41 This arrangement allows for packages to be easily disabled or
     42 excised as necessary, either on a per-license or per-package basis.
     43 
     44 The licenses currently used are:
     45 
     46 	bsd		BSD (or equivalent) licensed software, possibly with
     47 			the "advertising clause".
     48 
     49 If a package has components covered by different licenses
     50 (for example, GPL2 and the LGPL), use the <license> subdirectory
     51 for the more restrictive license.
     52 
     53 If a package allows the choice of a license to use, we'll
     54 generally use the less restrictive license.
     55 
     56 If in doubt about where a package should be located, please
     57 contact <core (a] NetBSD.org> for advice.
     58 
     59 
     60 Migration Strategy:
     61 
     62 
     63 Eventually src/dist (and associated framework in other base source
     64 directories) and src/gnu will be migrated to this hierarchy.
     65 
     66 
     67 Maintenance Strategy:
     68 
     69 The sources under src/external/<license>/<package>/dist/ are
     70 generally a combination of a published distribution plus changes
     71 that we submit to the maintainers and that are not yet published
     72 by them.
     73 
     74 Make sure all changes made to the external sources are submitted
     75 to the appropriate maintainer, but only after coordinating with
     76 the NetBSD maintainers.
     77