11.16Smaya# $NetBSD: README,v 1.16 2021/09/25 08:54:30 maya Exp $
21.1Scgd
31.1Scgdthe scripts should be run from the directory where they reside.
41.1Scgd
51.1Scgdmakeflist:	output the list of files that should be in a
61.1Scgd		distribution, according to the contents of the
71.1Scgd		'lists' directory.
81.1Scgd
91.1Scgdcheckflist:	check the file list (as internally generated
101.1Scgd		by makeflist) against the tree living in $DESTDIR.
111.1Scgd		(that tree should be made with 'make distribution'.)
121.1Scgd
131.1Scgdmaketars:	make tarballs of the various sets in the distribution,
141.1Scgd		based on the contents of the lists, the tree in
151.1Scgd		$DESTDIR, and put the tarballs in $RELEASEDIR.
161.1Scgd		Note that this script _doesn't_ create the 'secr'
171.1Scgd		distribution, because (for now) it requires
181.1Scgd		manual intervention to get the binaries right...
191.1Scgd		(i'll add another script to create that dist, later.)
201.1Scgd
211.1Scgdwhat's in 'lists':
221.1Scgd
231.1Scgdlists describing file sets.  There are two sets of lists per file
241.1Scgdset: machine dependent and machine-independent files. (there's
251.1Scgdalso another file in the 'man' dir, which is used by the 'man'
261.1Scgdand 'misc' sets, but that's explained later.)
271.1Scgd
281.1ScgdThere is one machine-independent file, named "mi".  There are
291.1ScgdN machine-dependent files (one per architecture), named "md.${ARCH}".
301.5Sjmc
311.1Scgdthe sets are as follows:
321.1Scgd
331.1Scgd	base:	the base binary set.  excludes everything described
341.1Scgd		below.
351.1Scgd
361.1Scgd	comp:	compiler tools.  All of the tools relating to C, C++,
371.1Scgd		and FORTRAN (yes, there are two!) that are in the
381.1Scgd		tree.  This includes includes, the linker, tool chain,
391.1Scgd		and the .a versions of the libraries.  (obviously,
401.1Scgd		base includes ldd, ld.so, and the shared versions.
411.1Scgd		base also includes 'cpp', because that's used by X11.)
421.1Scgd		includes the man pages for all the binaries contained
431.1Scgd		within.  Also, includes all library and system call
441.1Scgd		manual pages.
451.1Scgd
461.12Schristos	debug:	Debugging libraries (_g.a/MKDEBUGLIB) and (.debug/MKDEBUG)
471.12Schristos		binaries.
481.12Schristos
491.15Sjmcneill	dtb:	Device tree blobs (MKDTB).
501.15Sjmcneill
511.1Scgd	etc:	/etc, and associated files (/var/cron/tabs, /root,
521.1Scgd		etc.).  things that shouldn't be blindly reinstalled
531.1Scgd		on an upgrade.
541.1Scgd
551.1Scgd	games:	the games and their man pages.
561.1Scgd
571.16Smaya	gpufw:	heavy firmware files used by graphical drivers.
581.16Smaya
591.1Scgd	man:	all of the man pages for the system, except those
601.1Scgd		listed elsewhere (e.g. in comp, games, misc, text).
611.1Scgd		Includes machine-dependent man pages for this CPU.
621.1Scgd
631.1Scgd	misc:	share/dict, share/doc, and the machine-dependent
641.6Swiz		man pages for other CPUs which happen to always
651.1Scgd		be installed.
661.1Scgd
671.9Sjnemeth	modules:	stand/${MACHINE}/${OSRELEASE}/modules kernel modules
681.9Sjnemeth
691.14Smaya	rescue:	Standalone system recovery tools.
701.14Smaya
711.7Sjmmv	tests:	unit, regression, integration and stress tests for the
721.7Sjmmv		whole system.
731.7Sjmmv
741.1Scgd	text:	text processing tools.  groff and all of its friends.
751.1Scgd		includes man pages for all bins contained within.
761.1Scgd
771.11SjnemethEach set must contain "./etc/mtree/set.<set name>" within the mi
781.11Sjnemethlist.  Failure to add this will break unprivileged builds.
79