svn commit: r244994 - head/usr.sbin/bsdconfig/share

[Devin Teske]

Author: dteske
Date: Thu Jan  3 15:48:00 2013
New Revision: 244994
URL: http://svnweb.freebsd.org/changeset/base/244994

Log:
  Comments.

Modified:
  head/usr.sbin/bsdconfig/share/common.subr

Modified: head/usr.sbin/bsdconfig/share/common.subr
==============================================================================
--- head/usr.sbin/bsdconfig/share/common.subr	Thu Jan  3 15:31:23 2013	(r244993)
+++ head/usr.sbin/bsdconfig/share/common.subr	Thu Jan  3 15:48:00 2013	(r244994)
@@ -64,10 +64,16 @@ export UNAME_R="$(uname -r)" # Release L
 
 ############################################################ FUNCTIONS
 
+# f_dprintf $fmt [ $opts ... ]
 #
 # Sensible debug function. Override in ~/.bsdconfigrc if desired.
 # See /usr/share/examples/bsdconfig/bsdconfigrc for example.
 #
+# If $debug is set and non-NULL, prints DEBUG info using printf(1) syntax:
+# 	+ To $debugFile, if set and non-NULL
+# 	+ To standard output if $debugFile is either NULL or unset
+# 	+ To both if $debugFile begins with a single plus-sign (`+')
+#
 f_dprintf()
 {
 	[ "$debug" ] || return $SUCCESS