[src/trunk]: src/share/man/man5 Initial attempt at documenting the KERNEL_DIR...

[pgoyette <pgoyette%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/787c7e73e86b
branches:  trunk
changeset: 1017885:787c7e73e86b
user:      pgoyette <pgoyette%NetBSD.org@localhost>
date:      Thu Jan 14 23:32:12 2021 +0000

description:
Initial attempt at documenting the KERNEL_DIR option.

XXX EXPERIMENTAL, Work-In-Progress ! XXX

diffstat:

 share/man/man5/mk.conf.5 |  33 ++++++++++++++++++++++++++++++++-
 1 files changed, 32 insertions(+), 1 deletions(-)

diffs (47 lines):

diff -r 96886d7479e2 -r 787c7e73e86b share/man/man5/mk.conf.5
--- a/share/man/man5/mk.conf.5  Thu Jan 14 23:30:50 2021 +0000
+++ b/share/man/man5/mk.conf.5  Thu Jan 14 23:32:12 2021 +0000
@@ -1,4 +1,4 @@
-.\"    $NetBSD: mk.conf.5,v 1.83 2020/11/10 21:47:49 kamil Exp $
+.\"    $NetBSD: mk.conf.5,v 1.84 2021/01/14 23:32:12 pgoyette Exp $
 .\"
 .\"  Copyright (c) 1999-2003 The NetBSD Foundation, Inc.
 .\"  All rights reserved.
@@ -182,6 +182,37 @@
 .Sq expert
 mode
 .
+.It Sy KERNEL_DIR (EXPERIMENTAL)
+.YorN
+Indicates if a top-level directory
+.Sy /netbsd/
+is created.
+If
+.Dq yes ,
+the directory will contain a kernel file
+.Pa /netbsd/kernel
+and a corresponding modules directory
+.Pa /netbsd/modules/ .
+System bootstrap procedures will be modified to search for the kernel
+and modules in the
+.Pa /netbsd/
+directory.
+This is intended to simplify system upgrade and rollback procedures by
+keeping the kernel and its associated modules together in one place.
+.Pp
+If
+.Dq no ,
+the kernel file will be stored in
+.Pa /netbsd
+and the modules will be stored within the
+.Pa /stand/${ARCH}/
+directory hierarchy.
+.Pp
+The
+.Sy KERNEL_DIR
+option is a work-in-progress, and is highly experimental.
+It is also subject to change without notice.
+.DFLTn
 .It Sy MAKEVERBOSE
 Level of verbosity of status messages.
 Supported values: