Bug#671355: [debconf_spec] Document escape capability.

[Jonathan Nieder <jrnieder@gmail.com>]

Hi Charles,

Charles Plessy wrote:

> while browsing in my pile of unanswered emails, I found that we lost momentum
> on this issue.  Can somebody have a look at the patch below and second if
> appropriate ?

Thanks for a reminder.

>> Subject: [PATCH] Document Debconf's escape capability.

A good thing to do.

[...]
>> --- a/debconf_spec/include/commands.xml
>> +++ b/debconf_spec/include/commands.xml
>> @@ -41,6 +41,14 @@
>>  	  </entry>
>>          </row>
>> +	<row>
>> +	  <entry>escape</entry>
>> +	  <entry>
>> +	    Backslashes and newlines escape is supported.  See
>> +	    <citerefentry><refentrytitle>debconf-escape</refentrytitle>
>> +	    <manvolnum>1</manvolnum></citerefentry>.
>> +	  </entry>
>> +	</row>
>>  	<row>

This is ungrammatical, and when I look at debconf-escape(1) it seems
to tell me the "escape" capability does not represent additional
support --- instead it represents different behavior.

How about

	The frontend expects commands sent to it to have backslashes
	and newlines quoted as \\ and \n respectively and will
	in turn quote backslashes and newlines in its replies.
	See <citerefentry><refentrytitle>debconf-escape</refentrytitle>
	<manvolnum>1</manvolnum></citerefentry>.

?

Thanks,
Jonathan