[src/trunk]: src/distrib/utils/embedded Add some documentation:

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

details:   https://anonhg.NetBSD.org/src/rev/3d7d2a8e6c52
branches:  trunk
changeset: 337547:3d7d2a8e6c52
user:      hubertf <hubertf%NetBSD.org@localhost>
date:      Sun Apr 19 17:56:57 2015 +0000

description:
Add some documentation:
Tell what this does, and what it expects from conf files

diffstat:

 distrib/utils/embedded/mkimage |  16 +++++++++++++++-
 1 files changed, 15 insertions(+), 1 deletions(-)

diffs (31 lines):

diff -r e0d455c4b303 -r 3d7d2a8e6c52 distrib/utils/embedded/mkimage
--- a/distrib/utils/embedded/mkimage    Sun Apr 19 16:14:03 2015 +0000
+++ b/distrib/utils/embedded/mkimage    Sun Apr 19 17:56:57 2015 +0000
@@ -1,5 +1,5 @@
 #!/bin/sh
-# $NetBSD: mkimage,v 1.57 2015/04/18 22:06:48 hubertf Exp $
+# $NetBSD: mkimage,v 1.58 2015/04/19 17:56:57 hubertf Exp $
 #
 # Copyright (c) 2013, 2014 The NetBSD Foundation, Inc.
 # All rights reserved.
@@ -32,6 +32,20 @@
 # POSSIBILITY OF SUCH DAMAGE.
 #
 
+#
+# Makes a bootable image for the host architecture given.
+# The host specific functions are pulled in from a /bin/sh script in the
+# "conf" directory, and is expected to provide the following shell
+# functions, which are called in the following order:
+#
+#  - make_fstab: Creates the host's /etc/fstab with / on ${rootdev}.
+#    If -m is given, a number of directories are put on a tmpfs RAM disk
+#  - customize: After unpacking the sets, this gets the system to
+#    a working state, e. g. by setting up /etc/rc.conf and /dev
+#  - populate: Add common goods like kernel and bootloader
+#  - make_label: Prints disklabel to stdout
+#
+
 set -e
 
 DIR="$(cd "$(dirname "$0")" && pwd)"