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