[src/trunk]: src/doc BUILDINFO part 5: Document BUILDINFO in doc/BUILDING.mdoc.

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

details:   https://anonhg.NetBSD.org/src/rev/1b3cf0d5d3d3
branches:  trunk
changeset: 797908:1b3cf0d5d3d3
user:      apb <apb%NetBSD.org@localhost>
date:      Sun Aug 03 09:24:08 2014 +0000

description:
BUILDINFO part 5: Document BUILDINFO in doc/BUILDING.mdoc.

diffstat:

 doc/BUILDING.mdoc |  21 ++++++++++++++++++++-
 1 files changed, 20 insertions(+), 1 deletions(-)

diffs (35 lines):

diff -r 7da3b73ea403 -r 1b3cf0d5d3d3 doc/BUILDING.mdoc
--- a/doc/BUILDING.mdoc Sun Aug 03 09:22:29 2014 +0000
+++ b/doc/BUILDING.mdoc Sun Aug 03 09:24:08 2014 +0000
@@ -1,4 +1,4 @@
-.\"    $NetBSD: BUILDING.mdoc,v 1.100 2014/06/14 12:20:17 apb Exp $
+.\"    $NetBSD: BUILDING.mdoc,v 1.101 2014/08/03 09:24:08 apb Exp $
 .\"
 .\" Copyright (c) 2001-2011 The NetBSD Foundation, Inc.
 .\" All rights reserved.
@@ -351,6 +351,25 @@
 .Dq Li uname \-v .
 .DFLTu
 .
+.It Sy BUILDINFO
+This may be a multi-line string containing information about the build.
+This will appear in
+.Sy DESTDIR Ns Pa /etc/release ,
+and it will be stored in the
+.Va buildinfo
+variable in any kernels that are built.
+When such kernels are booted, the
+.Xr sysctl 7
+.Va kern.buildinfo
+variable will report this value.
+The string may contain backslash escape sequences, such as
+.Dq "\e\e"
+(representing a backslash character)
+and
+.Dq "\en"
+(representing a newline).
+.DFLTu
+.
 .It Sy BUILDSEED
 GCC uses random numbers when compiling C++ code.
 This variable seeds the gcc random number generator using