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