os/doc
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Update UCL examples of short and multiline strings

Browse source 
Submitted by:	dbaio
Differential Revision:	https://reviews.freebsd.org/D20666
This commit is contained in:
Mathieu Arnold 2019-06-22 11:34:20 +00:00
parent 5ddc1b5082
commit a59f7f697d
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/head/; revision=53177
1 changed files with 38 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

63
en_US.ISO8859-1/books/porters-handbook/pkg-files/chapter.xml
View file

@ -164,30 +164,7 @@
</varlistentry>
</variablelist>
<tip>
<para>UCL allows for two kind of strings, either delimited
by double quotes
<literal>"<replaceable>foo</replaceable>"</literal>, or as a
here document. These two
are equivalent:</para>
<programlisting>[
{ message: "Always displayed"
}
]</programlisting>
<programlisting>[
{ message: &lt;&lt;EOM
Always displayed
EOM
}
]</programlisting>
<para>The here document delimiter (<literal>EOM</literal>
here) must be uppercase.</para>
</tip>
<warning>
<important>
<para>To preserve the compatibility with non
<acronym>UCL</acronym> <filename>pkg-message</filename>
files, the first line of a <acronym>UCL</acronym>
@ -196,7 +173,43 @@ EOM
<quote><literal>[</literal></quote>, and the last line
<emphasis>MUST be</emphasis> a single
<quote><literal>]</literal></quote>.</para>
</warning>
</important>
<example xml:id="porting-message-ucl-short-ex">
<title><acronym>UCL</acronym> Short Strings</title>
<para>The message is delimited by double quotes
<literal>"</literal>, this is used for simple single line
strings:</para>
<programlisting>[
{
message: "Simple message"
}
]</programlisting>
</example>
<example xml:id="porting-message-ucl-multiline-ex">
<title><acronym>UCL</acronym> Multiline Strings</title>
<para>Multiline strings use the standard here document
notation. The multiline delimiter <emphasis>must</emphasis>
start just after <literal>&lt;&lt;</literal> symbols without
any whitespace and it <emphasis>must</emphasis> consist of
capital letters only. To finish a multiline string, add the
delimiter string on a line of its own without any
whitespace. The message from <xref
linkend="porting-message-ucl-short-ex"/> can be written
as:</para>
<programlisting>[
{
message: &lt;&lt;EOM
Simple message
EOM
}
]</programlisting>
</example>
<example xml:id="porting-message-ucl-ex1">
<title>Always Display a Message</title>