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