From owner-svn-src-head@FreeBSD.ORG  Thu Nov  7 10:44:24 2013
Return-Path: <owner-svn-src-head@FreeBSD.ORG>
Delivered-To: svn-src-head@freebsd.org
Received: from mx1.freebsd.org (mx1.freebsd.org [8.8.178.115])
 (using TLSv1 with cipher ADH-AES256-SHA (256/256 bits))
 (No client certificate requested)
 by hub.freebsd.org (Postfix) with ESMTP id B893416A;
 Thu,  7 Nov 2013 10:44:24 +0000 (UTC)
 (envelope-from dteske@FreeBSD.org)
Received: from svn.freebsd.org (svn.freebsd.org
 [IPv6:2001:1900:2254:2068::e6a:0])
 (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits))
 (No client certificate requested)
 by mx1.freebsd.org (Postfix) with ESMTPS id A6BE6212B;
 Thu,  7 Nov 2013 10:44:24 +0000 (UTC)
Received: from svn.freebsd.org ([127.0.1.70])
 by svn.freebsd.org (8.14.7/8.14.7) with ESMTP id rA7AiOQ5035881;
 Thu, 7 Nov 2013 10:44:24 GMT (envelope-from dteske@svn.freebsd.org)
Received: (from dteske@localhost)
 by svn.freebsd.org (8.14.7/8.14.5/Submit) id rA7AiOEZ035880;
 Thu, 7 Nov 2013 10:44:24 GMT (envelope-from dteske@svn.freebsd.org)
Message-Id: <201311071044.rA7AiOEZ035880@svn.freebsd.org>
From: Devin Teske <dteske@FreeBSD.org>
Date: Thu, 7 Nov 2013 10:44:24 +0000 (UTC)
To: src-committers@freebsd.org, svn-src-all@freebsd.org,
 svn-src-head@freebsd.org
Subject: svn commit: r257789 - head/usr.sbin/bsdconfig/share
X-SVN-Group: head
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
X-BeenThere: svn-src-head@freebsd.org
X-Mailman-Version: 2.1.14
Precedence: list
List-Id: SVN commit messages for the src tree for head/-current
 <svn-src-head.freebsd.org>
List-Unsubscribe: <http://lists.freebsd.org/mailman/options/svn-src-head>,
 <mailto:svn-src-head-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/svn-src-head>
List-Post: <mailto:svn-src-head@freebsd.org>
List-Help: <mailto:svn-src-head-request@freebsd.org?subject=help>
List-Subscribe: <http://lists.freebsd.org/mailman/listinfo/svn-src-head>,
 <mailto:svn-src-head-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Thu, 07 Nov 2013 10:44:24 -0000

Author: dteske
Date: Thu Nov  7 10:44:24 2013
New Revision: 257789
URL: http://svnweb.freebsd.org/changeset/base/257789

Log:
  Comments.

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

Modified: head/usr.sbin/bsdconfig/share/strings.subr
==============================================================================
--- head/usr.sbin/bsdconfig/share/strings.subr	Thu Nov  7 10:40:19 2013	(r257788)
+++ head/usr.sbin/bsdconfig/share/strings.subr	Thu Nov  7 10:44:24 2013	(r257789)
@@ -46,7 +46,7 @@ VALID_VARNAME_CHARS="0-9ABCDEFGHIJKLMNOP
 
 ############################################################ FUNCTIONS
 
-# f_substr "$string" $start [ $length ]
+# f_substr "$string" $start [$length]
 #
 # Simple wrapper to awk(1)'s `substr' function.
 #
@@ -56,16 +56,16 @@ f_substr()
 	echo "$string" | awk "{ print substr(\$0, $start, $len) }"
 }
 
-# f_snprintf $var_to_set $size $format ...
+# f_snprintf $var_to_set $size $format [$arguments ...]
 #
 # Similar to snprintf(3), write at most $size number of bytes into $var_to_set
-# using printf(1) syntax (`$format ...'). The value of $var_to_set is NULL
-# unless at-least one byte is stored from the output.
+# using printf(1) syntax (`$format [$arguments ...]'). The value of $var_to_set
+# is NULL unless at-least one byte is stored from the output.
 #
 f_snprintf()
 {
 	local __var_to_set="$1" __size="$2"
-	shift 2 # var_to_set/size
+	shift 2 # var_to_set size
 	eval "$__var_to_set"=\$\( printf \"\$@\" \| awk -v max=\"\$__size\" \''
 	{
 		len = length($0)