opnsense-src/etc/mtree
Kyle Evans 00640ea314 tee: add some basic tests
The cases are ordered in such a way that we naturally progress through
the functionality, with the earliest failures perhaps shedding light on
any later failures.

sysutils/porch is used for one test if it's available, just to cleanly
check that SIGINT is being ignored properly.

Reviewed by:	des, emaste

(cherry picked from commit 85ff0b08ee699ff323404727998993275b4d2e2a)
2025-04-25 22:19:48 -05:00
..
BSD.debug.dist mtree: Add missing flua entry 2025-02-17 20:09:00 +00:00
BSD.include.dist Merge llvm-project main llvmorg-19-init-18630-gf2ccf80136a0 2024-12-01 12:16:52 +01:00
BSD.lib32.dist Remove $FreeBSD$: one-line sh pattern 2023-08-16 11:55:03 -06:00
BSD.release.dist Remove $FreeBSD$: one-line sh pattern 2023-08-16 11:55:03 -06:00
BSD.root.dist mtree: Add missing directories generated by certctl 2024-05-22 15:29:19 -06:00
BSD.sendmail.dist Remove $FreeBSD$: one-line sh pattern 2023-08-16 11:55:03 -06:00
BSD.tests.dist tee: add some basic tests 2025-04-25 22:19:48 -05:00
BSD.usr.dist Merge llvm-project main llvmorg-19-init-18630-gf2ccf80136a0 2024-12-01 12:16:52 +01:00
BSD.var.dist Remove remnants of portsnap(8) 2024-05-09 15:52:53 +09:00
Makefile etc: remove leftover leading empty comments, blank lines 2023-08-22 13:03:28 -05:00
README etc: remove leftover leading empty comments, blank lines 2023-08-22 13:03:28 -05:00

Note: If you modify these files, please keep hier(7) updated!

These files are used to create empty file hierarchies for building the
system into.  Some notes about working with them are placed here to try
and keep them in good working order.

    a)  The files use 4 space indentation, and other than in the header
        comments, should not contain any tabs.  An indentation of 4 is
        preferable to the standard indentation of 8 because the indentation
        of levels in these files can become quite deep causing the line to
        overflow 80 characters.

        This also matches with the files generated when using the
        mtree -c option, which was implemented that way for the same reason.

    b)  Only directories should be listed here.

    c)  The listing should be kept in filename sorted order.

    d)  Sanity checking changes to these files can be done by following
        this procedure (the sed -e is ugly, but fixing mtree -c to
        not emit the trailing white space would be even uglier):

            mkdir /tmp/MTREE
            mtree -deU -f BSD.X.dist -p /tmp/MTREE
            mtree -cdin -k uname,gname,mode -p /tmp/MTREE | \
		sed -e 's/ *$//' >BSD.X.new
            diff -u BSD.X.dist BSD.X.new
            rm -r /tmp/MTREE

        Note that you will get some differences about /set lines,
        and uname= gname= on certain directory areas, mainly man page
        sections.  This is caused by mtree not having a look ahead
        mechanism for making better selections for these as it
        traverses the hierarchy.

        The BSD.X.new file should NOT be committed, as it will be missing
        the correct header, and important keywords like ``nochange''.
        Simply use the diff for a sanity check to make sure things are in
        the correct order and correctly indented.

    e)  Further sanity checking of the system builds with DESTDIR=/someplace
        are more complicated, but can often catch missing entries in these
        files.  I tend to run this more complete sanity check shortly after
        the target date for a new release is announced.

        If you want details on it bug me about it via email to
        rgrimes@FreeBSD.org.