xref: /netbsd-src/external/README (revision bbde328be4e75ea9ad02e9715ea13ca54b797ada)
1$NetBSD: README,v 1.9 2010/05/01 19:51:33 christos Exp $
2
3Organization of Sources:
4
5This directory hierarchy is using an organization that separates
6source for programs that we have obtained from external third
7parties (where NetBSD is not the primary maintainer) from the
8system source.
9
10The hierarchy is grouped by license, and then package per license,
11and 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
39This arrangement allows for packages to be easily disabled or
40excised as necessary, either on a per-license or per-package basis.
41
42The 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	ibm-public	IBM's public license:
63			http://www.opensource.org/licenses/ibmpl.php
64
65	intel-fw-eula	Intel firmware license with redistribution
66			restricted to OEM.
67
68	intel-fw-public	Intel firmware license permitting redistribution with
69			terms similar to BSD licensed software.
70
71	intel-public	Intel license permitting redistribution with
72			terms similar to BSD licensed software.
73
74	mit		MIT (X11) style license.
75			http://www.opensource.org/licenses/mit-license.php
76
77If a package has components covered by different licenses
78(for example, GPL2 and the LGPL), use the <license> subdirectory
79for the more restrictive license.
80
81If a package allows the choice of a license to use, we'll
82generally use the less restrictive license.
83
84If in doubt about where a package should be located, please
85contact <core@NetBSD.org> for advice.
86
87
88Migration Strategy:
89
90
91Eventually src/dist (and associated framework in other base source
92directories) and src/gnu will be migrated to this hierarchy.
93
94
95Maintenance Strategy:
96
97The sources under src/external/<license>/<package>/dist/ are
98generally a combination of a published distribution plus changes
99that we submit to the maintainers and that are not yet published
100by them.
101
102Make sure all changes made to the external sources are submitted
103to the appropriate maintainer, but only after coordinating with
104the NetBSD maintainers.
105