svn commit: r366026 - head/share/man/man4

[Warner Losh]

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

Log:
  Document quoting requirements for the devctl protocol
  
  Belatedly document the quoting requirements for the devctl protocol. I
  thought they'd been previously documented.
  
  Also, while I'm here, make igor happy.
  
  Reviewed by: bcr
  Differential Revision: https://reviews.freebsd.org/D26520

Modified:
  head/share/man/man4/devctl.4

Modified: head/share/man/man4/devctl.4
==============================================================================
--- head/share/man/man4/devctl.4	Tue Sep 22 23:01:53 2020	(r366025)
+++ head/share/man/man4/devctl.4	Tue Sep 22 23:01:57 2020	(r366026)
@@ -23,12 +23,16 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd March 26, 2014
+.Dd September 21, 2020
 .Dt DEVCTL 4
 .Os
 .Sh NAME
 .Nm devctl
 .Nd "device event reporting and device control interface"
+.Sh SYNOPSIS
+The
+.Nm
+driver is automatically included in the kernel.
 .Sh DESCRIPTION
 The
 .Nm
@@ -124,5 +128,17 @@ driver.
 The attach message driver has already claimed this device.
 One cannot use the detach messages to flush data to the device.
 The device is already gone.
+.Pp
+All values passed back are of the form
+.Sq key=value
+or
+.Sq key="value" .
+When the latter, the string
+.Dq value
+must have any internal backslashes doubled.
+It must also have any internal double quote characters
+.Sq "
+preceded by a backslash.
+All other characters should be passed through.
 .Sh SEE ALSO
 .Xr devd 8