From a5dca7c7e4fa30ba77e311d59fad1a65c7ada7e6 Mon Sep 17 00:00:00 2001
From: Warner Losh <imp@FreeBSD.org>
Date: Tue, 22 Sep 2020 23:01:57 +0000
Subject: [PATCH] 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
---
 share/man/man4/devctl.4 | 18 +++++++++++++++++-
 1 file changed, 17 insertions(+), 1 deletion(-)

diff --git a/share/man/man4/devctl.4 b/share/man/man4/devctl.4
index dc035f1246d..4403cb4fdd7 100644
--- a/share/man/man4/devctl.4
+++ b/share/man/man4/devctl.4
@@ -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