xref: /netbsd-src/external/README (revision fff57c5525bbe431aee7bdb3983954f0627a42cb)
1$NetBSD: README,v 1.1 2008/05/22 12:44:26 lukem 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 the 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.
41
42The licenses currently used are:
43
44	bsd	BSD (or equivalent) licensed software, possibly with
45		the "advertising clause".
46
47
48Eventually src/dist (and associated framework in other base source
49directories) and src/gnu will be migrated to this hierarchy.
50
51
52Maintenance Strategy:
53
54The sources under src/external/<license>/<package>/dist/ are
55generally a combination of a published distribution plus changes
56that we submit to the maintainers and that are not yet published
57by them.
58
59Make sure all changes made to the external sources are submitted
60to the appropriate maintainer, but only after coordinating with
61the NetBSD maintainers.
62