README
1$NetBSD: README,v 1.14.8.1 2012/08/13 23:18:23 riz 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 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 public-domain Non-license for code that has been explicitly put
83 into the Public Domain.
84
85 realtek RealTek license.
86
87 zlib Zlib (BSD-like) license.
88 http://www.zlib.net/zlib_license.html
89
90If a package has components covered by different licenses
91(for example, GPL2 and the LGPL), use the <license> subdirectory
92for the more restrictive license.
93
94If a package allows the choice of a license to use, we'll
95generally use the less restrictive license.
96
97If in doubt about where a package should be located, please
98contact <core@NetBSD.org> for advice.
99
100
101Migration Strategy:
102
103
104Eventually src/dist (and associated framework in other base source
105directories) and src/gnu will be migrated to this hierarchy.
106
107
108Maintenance Strategy:
109
110The sources under src/external/<license>/<package>/dist/ are
111generally a combination of a published distribution plus changes
112that we submit to the maintainers and that are not yet published
113by them.
114
115Make sure all changes made to the external sources are submitted
116to the appropriate maintainer, but only after coordinating with
117the NetBSD maintainers.
118