diff options
author | Scott Rifenbark <srifenbark@gmail.com> | 2018-04-18 08:07:17 -0700 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2018-05-24 17:16:19 +0100 |
commit | 266ed1c3dea3436ba6a302ba52cf9a776320b263 (patch) | |
tree | c336808ccd9f4a645e5dca5fdbe13bbb0e2e8680 /documentation/ref-manual | |
parent | 5a049e572cc7714baf49a765702b2939df972d21 (diff) | |
download | poky-266ed1c3dea3436ba6a302ba52cf9a776320b263.tar.gz |
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>
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r-- | documentation/ref-manual/ref-variables.xml | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index a0b22cd506..7db714a8fc 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml | |||
@@ -1871,7 +1871,7 @@ | |||
1871 | <para> | 1871 | <para> |
1872 | Git requires that the value you provide for the | 1872 | Git requires that the value you provide for the |
1873 | <filename>BUILDHISTORY_COMMIT_AUTHOR</filename> variable | 1873 | <filename>BUILDHISTORY_COMMIT_AUTHOR</filename> variable |
1874 | takes the form of "name <email@host>". | 1874 | takes the form of "name <replaceable>email@host</replaceable>". |
1875 | Providing an email address or host that is not valid does | 1875 | Providing an email address or host that is not valid does |
1876 | not produce an error. | 1876 | not produce an error. |
1877 | </para> | 1877 | </para> |