From: Charles Plessy <plessy@debian.org>
Date: Sun, 16 Sep 2012 23:01:07 +0000 (+0900)
Subject: Document Debconf's escape capability.
X-Git-Url: https://git.donarmstrong.com/?p=debian%2Fdebian-policy.git;a=commitdiff_plain;h=3ee78f55b70f74b4bb67bcffbae8ed886156a99b

Document Debconf's escape capability.

Closes: #671355.
---

diff --git a/debconf_spec/include/commands.xml b/debconf_spec/include/commands.xml
index d5bad36..b8d30c2 100644
--- a/debconf_spec/include/commands.xml
+++ b/debconf_spec/include/commands.xml
@@ -40,6 +40,16 @@
 	    Backing up to a previous step is supported.
 	  </entry>
         </row>
+	<row>
+	  <entry>escape</entry>
+	  <entry>
+	    The frontend expects commands sent to it to have backslashes and
+	    newlines quoted as <literal>\\</literal> and <literal>\n</literal>
+	    respectively and will in turn quote backslashes and newlines in its
+	    replies.  See <citerefentry><refentrytitle>debconf-escape</refentrytitle>
+	    <manvolnum>1</manvolnum></citerefentry>.
+	  </entry>
+	</row>
 	<row>
 	  <entry>multiselect</entry>
 	  <entry>
diff --git a/debian/changelog b/debian/changelog
index 86563dd..de62f2d 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -16,6 +16,11 @@ debian-policy (3.9.5.0) UNRELEASED; urgency=low
     Seconded: Guillem Jover <guillem@debian.org>
     Seconded: Ansgar Burchardt <ansgar@debian.org>
     Closes: #690293
+  * debconf_spec: Document the 'escape' capability.
+    Wording: Jonathan Nieder <jrnieder@gmail.com>
+    Seconded: Charles Plessy <plessy@debian.org>
+    Seconded: Russ Allbery <rra@debian.org>
+    Closes: #671355
   * Remove outdated mention of dselect documentation.
     Closes: #700574.  Thanks, Guillem Jover.
   * Update dak reference from old katie name.
diff --git a/upgrading-checklist.sgml b/upgrading-checklist.sgml
index 1b390ca..6ebbded 100644
--- a/upgrading-checklist.sgml
+++ b/upgrading-checklist.sgml
@@ -55,6 +55,9 @@ Unreleased.
   <item>New section documenting the <tt>Package-Type</tt> field in source
   package control files.
   </item>
+<tag>debconf</tag>
+  <item>The <tt>escape</tt> capability is now documented.
+  </item>
 </taglist></p>
 
 <sect id="3.9.4.0"> Version 3.9.4.0