xref: /netbsd-src/external/README (revision 2e31951ce35b19b425cc71066afbe82e73ab68f4)
1$NetBSD: README,v 1.5 2008/10/30 00:27:31 joerg 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	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 similiar to BSD licensed software.
54
55	mit		MIT (X11) style license.
56
57If a package has components covered by different licenses
58(for example, GPL2 and the LGPL), use the <license> subdirectory
59for the more restrictive license.
60
61If a package allows the choice of a license to use, we'll
62generally use the less restrictive license.
63
64If in doubt about where a package should be located, please
65contact <core@NetBSD.org> for advice.
66
67
68Migration Strategy:
69
70
71Eventually src/dist (and associated framework in other base source
72directories) and src/gnu will be migrated to this hierarchy.
73
74
75Maintenance Strategy:
76
77The sources under src/external/<license>/<package>/dist/ are
78generally a combination of a published distribution plus changes
79that we submit to the maintainers and that are not yet published
80by them.
81
82Make sure all changes made to the external sources are submitted
83to the appropriate maintainer, but only after coordinating with
84the NetBSD maintainers.
85