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