svn commit: r366025 - head/share/man/man9

[Warner Losh]

Author: imp
Date: Tue Sep 22 23:01:53 2020
New Revision: 366025
URL: https://svnweb.freebsd.org/changeset/base/366025

Log:
  Document devctl_safe_quote_sb
  
  This routine centralizes the knowledge needed for properly quoting
  'value' in all key="value" items that appear in devctl messages.
  
  Reviewed by: bcr
  Differential Revision: https://reviews.freebsd.org/D26520

Added:
  head/share/man/man9/devctl_safe_quote_sb.9   (contents, props changed)
Modified:
  head/share/man/man9/Makefile

Modified: head/share/man/man9/Makefile
==============================================================================
--- head/share/man/man9/Makefile	Tue Sep 22 23:01:44 2020	(r366024)
+++ head/share/man/man9/Makefile	Tue Sep 22 23:01:53 2020	(r366025)
@@ -122,6 +122,8 @@ MAN=	accept_filter.9 \
 	DEV_MODULE.9 \
 	dev_refthread.9 \
 	devctl_process_running.9 \
+	devctl_safe_quote_sb.9 \
+	devctl_
 	devstat.9 \
 	devtoname.9 \
 	disk.9 \

Added: head/share/man/man9/devctl_safe_quote_sb.9
==============================================================================
--- /dev/null	00:00:00 1970	(empty, because file is newly added)
+++ head/share/man/man9/devctl_safe_quote_sb.9	Tue Sep 22 23:01:53 2020	(r366025)
@@ -0,0 +1,57 @@
+.\"
+.\" Copyright (c) 2020 M Warner Losh
+.\"
+.\" This program is free software.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
+.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
+.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+.\"
+.\" $FreeBSD$
+.\"
+.Dd September 22, 2020
+.Dt DEVCTL_SAFE_QUOTE_SB 9
+.Os
+.Sh NAME
+.Nm devctl_safe_quote_sb
+.Nd Insert a string, properly quoted, into a sbuf
+.Sh SYNOPSIS
+.In sys/devctl.h
+.In sys/sbuf.h
+.Ft void
+.Fn devctl_safe_quote_sb "struct sbuf *sb" "const char *src"
+.Sh DESCRIPTION
+Copy the string from
+.Vn src
+into
+.Vn sb .
+All backslash characters are doubled.
+All double quote characters
+.Sq "
+are also preceded by a backslash.
+All other characters are copied without modification.
+The
+.Xr devctl 4
+protocol requires quoted string to be quoted thus.
+This routine centralizes this knowledge.
+.Sh SEE ALSO
+.Xr devd 8
+.Sh AUTHORS
+This manual page was written by
+.An M. Warner Losh