ref-manual: Updated example string for BUILDHISTORY_COMMIT_AUTHOR.

I replaced the "<" and ">" constructs with the tags
<replaceable> and </replaceable>.  This is the preferred formatting
for user-supplied values.

(From yocto-docs rev: 1fc32486483c545671ffb2142b553da75dbe54fe)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark
2018-04-18 08:07:17 -07:00
committed by Richard Purdie
parent 5a049e572c
commit 266ed1c3de

View File

@@ -1871,7 +1871,7 @@
<para>
Git requires that the value you provide for the
<filename>BUILDHISTORY_COMMIT_AUTHOR</filename> variable
takes the form of "name &lt;email@host&gt;".
takes the form of "name <replaceable>email@host</replaceable>".
Providing an email address or host that is not valid does
not produce an error.
</para>