Document Debconf's escape capability.

Closes: #671355.

diff --git a/debconf_spec/include/commands.xml b/debconf_spec/include/commands.xml
index d5bad36e0c5fbc2bf10f5bf473e1740c169b4d5f..b8d30c27cadc339bbe461f255c56acc389a620fb 100644 (file)
--- 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 86563dd1b48546a7f8ae554ed6be7793f71e15a4..de62f2d246b545bbbe257261b20ecb87396e76be 100644 (file)
--- 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 1b390ca78ce213434ff21c0753d93baebe8cee88..6ebbded63bfe7ad9bd9c3dd602ab592c69100506 100644 (file)
--- 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