README revision 1.15 1 1.15 jmcneill # $NetBSD: README,v 1.15 2020/05/18 21:19:34 jmcneill Exp $
2 1.1 cgd
3 1.1 cgd the scripts should be run from the directory where they reside.
4 1.1 cgd
5 1.1 cgd makeflist: output the list of files that should be in a
6 1.1 cgd distribution, according to the contents of the
7 1.1 cgd 'lists' directory.
8 1.1 cgd
9 1.1 cgd checkflist: check the file list (as internally generated
10 1.1 cgd by makeflist) against the tree living in $DESTDIR.
11 1.1 cgd (that tree should be made with 'make distribution'.)
12 1.1 cgd
13 1.1 cgd maketars: make tarballs of the various sets in the distribution,
14 1.1 cgd based on the contents of the lists, the tree in
15 1.1 cgd $DESTDIR, and put the tarballs in $RELEASEDIR.
16 1.1 cgd Note that this script _doesn't_ create the 'secr'
17 1.1 cgd distribution, because (for now) it requires
18 1.1 cgd manual intervention to get the binaries right...
19 1.1 cgd (i'll add another script to create that dist, later.)
20 1.1 cgd
21 1.1 cgd what's in 'lists':
22 1.1 cgd
23 1.1 cgd lists describing file sets. There are two sets of lists per file
24 1.1 cgd set: machine dependent and machine-independent files. (there's
25 1.1 cgd also another file in the 'man' dir, which is used by the 'man'
26 1.1 cgd and 'misc' sets, but that's explained later.)
27 1.1 cgd
28 1.1 cgd There is one machine-independent file, named "mi". There are
29 1.1 cgd N machine-dependent files (one per architecture), named "md.${ARCH}".
30 1.5 jmc
31 1.1 cgd the sets are as follows:
32 1.1 cgd
33 1.1 cgd base: the base binary set. excludes everything described
34 1.1 cgd below.
35 1.1 cgd
36 1.1 cgd comp: compiler tools. All of the tools relating to C, C++,
37 1.1 cgd and FORTRAN (yes, there are two!) that are in the
38 1.1 cgd tree. This includes includes, the linker, tool chain,
39 1.1 cgd and the .a versions of the libraries. (obviously,
40 1.1 cgd base includes ldd, ld.so, and the shared versions.
41 1.1 cgd base also includes 'cpp', because that's used by X11.)
42 1.1 cgd includes the man pages for all the binaries contained
43 1.1 cgd within. Also, includes all library and system call
44 1.1 cgd manual pages.
45 1.1 cgd
46 1.12 christos debug: Debugging libraries (_g.a/MKDEBUGLIB) and (.debug/MKDEBUG)
47 1.12 christos binaries.
48 1.12 christos
49 1.15 jmcneill dtb: Device tree blobs (MKDTB).
50 1.15 jmcneill
51 1.1 cgd etc: /etc, and associated files (/var/cron/tabs, /root,
52 1.1 cgd etc.). things that shouldn't be blindly reinstalled
53 1.1 cgd on an upgrade.
54 1.1 cgd
55 1.1 cgd games: the games and their man pages.
56 1.1 cgd
57 1.1 cgd man: all of the man pages for the system, except those
58 1.1 cgd listed elsewhere (e.g. in comp, games, misc, text).
59 1.1 cgd Includes machine-dependent man pages for this CPU.
60 1.1 cgd
61 1.1 cgd misc: share/dict, share/doc, and the machine-dependent
62 1.6 wiz man pages for other CPUs which happen to always
63 1.1 cgd be installed.
64 1.1 cgd
65 1.9 jnemeth modules: stand/${MACHINE}/${OSRELEASE}/modules kernel modules
66 1.9 jnemeth
67 1.14 maya rescue: Standalone system recovery tools.
68 1.14 maya
69 1.7 jmmv tests: unit, regression, integration and stress tests for the
70 1.7 jmmv whole system.
71 1.7 jmmv
72 1.1 cgd text: text processing tools. groff and all of its friends.
73 1.1 cgd includes man pages for all bins contained within.
74 1.1 cgd
75 1.11 jnemeth Each set must contain "./etc/mtree/set.<set name>" within the mi
76 1.11 jnemeth list. Failure to add this will break unprivileged builds.
77