svn commit: r287383 - head/usr.sbin/sysrc

[Devin Teske]

Author: dteske
Date: Tue Sep  1 21:48:22 2015
New Revision: 287383
URL: https://svnweb.freebsd.org/changeset/base/287383

Log:
  Comment for escape() function.
  
  MFC after:	3 days
  X-MFC-to:	stable/10

Modified:
  head/usr.sbin/sysrc/sysrc

Modified: head/usr.sbin/sysrc/sysrc
==============================================================================
--- head/usr.sbin/sysrc/sysrc	Tue Sep  1 21:42:00 2015	(r287382)
+++ head/usr.sbin/sysrc/sysrc	Tue Sep  1 21:48:22 2015	(r287383)
@@ -195,6 +195,14 @@ jail_depend()
 	cat $BSDCFG_SHARE/sysrc.subr
 }
 
+# escape $string [$var_to_set]
+#
+# Escape $string contents so that the contents can be properly encapsulated in
+# single-quotes (making for safe evaluation).
+#
+# NB: See `bsdconfig includes -dF escape' for relevant information/discussion.
+# NB: Abridged version of `f_shell_escape()' from bsdconfig(8) `strings.subr'.
+#
 escape()
 {
 	local __start="$1" __var_to_set="$2" __string=