Module Name: src
Committed By: hubertf
Date: Sun Apr 19 17:56:57 UTC 2015
Modified Files:
src/distrib/utils/embedded: mkimage
Log Message:
Add some documentation:
Tell what this does, and what it expects from conf files
To generate a diff of this commit:
cvs rdiff -u -r1.57 -r1.58 src/distrib/utils/embedded/mkimage
Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.
Modified files:
Index: src/distrib/utils/embedded/mkimage
diff -u src/distrib/utils/embedded/mkimage:1.57 src/distrib/utils/embedded/mkimage:1.58
--- src/distrib/utils/embedded/mkimage:1.57 Sat Apr 18 22:06:48 2015
+++ src/distrib/utils/embedded/mkimage Sun Apr 19 17:56:57 2015
@@ -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)"
