Wed Apr 9 12:38:09 2014 UTC ()

Add comments about the intended use of each type of metadata message.


(apb)

diff -r1.166 -r1.167 src/etc/rc

--- src/etc/rc 2011/08/11 22:52:47	1.166
+++ src/etc/rc 2014/04/09 12:38:09	1.167

 @@ -1,16 +1,16 @@
 #!/bin/sh
+#
-# $NetBSD: rc,v 1.166 2011/08/11 22:52:47 apb Exp $
+# $NetBSD: rc,v 1.167 2014/04/09 12:38:09 apb Exp $
+#
 # rc --
 #	Run the scripts in /etc/rc.d with rcorder, and log output
 #	to /var/run/rc.log.
 #	System startup script run by init(8) on autoboot or after single-user.
 #	Output and error are redirected to console by init, and the console
 #	is the controlling terminal.
 export HOME=/
 export PATH=/sbin:/bin:/usr/sbin:/usr/bin
 umask 022
 @@ -267,84 +267,100 @@ rc_postprocess_metadata()
 	local msg
 	local IFS=':'
 	# given metadata="bleep:foo bar:baz",
 	# set keyword="bleep", args="foo bar:baz",
 	# $1="foo bar", $2="baz"
+	#
 	keyword="${metadata%%:*}"
 	args="${metadata#*:}"
 	set -- $args
 	case "$keyword" in
 	start)
-		# $args contains a date/time
+		# Marks the start of the entire /etc/rc script.
 		# $args contains a date/time.
 		rc_log_message "[$0 starting at $args]"
 		if ! $rc_silent; then
 			printf "%s\n" "$args"
 		fi
 		;;
 	cmd-name)
 		# Marks the start of a child script (usually one of
 		# the /etc/rc.d/* scripts).
 		rc_log_message "[running $1]"
 		;;
 	cmd-status)
 		# Marks the end of a child script.
 		# $1 is a command name, $2 is the command's exit status.
 		# If the command failed, report it, and add it to a list.
 		if [ "$2" != 0 ]; then
 			rc_failures="${rc_failures}${rc_failures:+ }$1"
 			msg="$1 $(human_exit_code $2)"
 			rc_log_message "$msg"
 			if ! $rc_silent; then
 				printf "%s\n" "$msg"
 			fi
 		fi
 		# After the mountcritlocal script has finished, it's
 		# OK to flush the log to disk
 		case "$1" in
 		*/mountcritlocal)
 			rc_log_flush OK
 			;;
 		esac
 		;;
 	nop)
 		# Do nothing.
 		# This has the side effect of flushing partial lines,
 		# and the echo() and printf() functions in rc.subr take
 		# advantage of this.
 		;;
 	note)
 		# Unlike most metadata messages, which should be used
 		# only by /etc/rc and rc.subr, the "note" message may be
 		# used directly by /etc.rc.d/* and similar scripts.
 		# It adds a note to the log file, without displaying
 		# it to stdout.
 		rc_log_message "[NOTE: $args]"
 		;;
 	end)
 		# Marks the end of processing, after the last child script.
-		# If any scripts (or other commands) failed, report them.
+		# If any child scripts (or other commands) failed, report them.
+		#
 		if [ -n "$rc_failures" ]; then
 			rc_log_message "[failures]"
 			msg="The following components reported failures:"
 			msg="${msg}${nl}$( echo "    ${rc_failures}" | fmt )"
 			msg="${msg}${nl}See ${RC_LOG_FILE} for more information."
 			rc_log_message "${msg}"
 			printf "%s\n" "${msg}"
 		fi
+		#
 		# Report the end date/time, even in silent mode
+		#
 		rc_log_message "[$0 finished at $args]"
 		printf "%s\n" "$args"
 		;;
 	exit)
 		# Marks an exit from the rc_real_work() function.
 		# This may be a normal or abnormal exit.
+		#
 		rc_log_message "[$0 exiting with status $1]"
 		exit $1
 		;;
 	interrupted)
-		# $args is a human-readable message
+		# Marks an interrupt trapped by the rc_real_work() function.
 		# $args is a human-readable message.
 		rc_log_message "$args"
 		printf "%s\n" "$args"
 		;;
 	*)
 		# an unrecognised line of metadata
 		rc_log_message "[metadata:${metadata}]"
 		;;
 	esac
+}
+#
 # rc_log_message string [...]
 #	Write a message to the log file, or buffer it for later.