mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-05-04 22:39:49 +02:00
Code Issues Packages Projects Releases Wiki Activity

ref-manual: Added BUILDHISTORY_COMMIT_AUTHOR to glossary.

Browse Source 
(From yocto-docs rev: 2cb9f1fca507910963cf701d5a0cf8b0ce333135)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark
2014-02-25 19:12:03 -06:00
committed by Richard Purdie
parent 47ca2108e1
commit 32338590a5
1 changed files with 30 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
documentation/ref-manual/ref-variables.xml
View File

@@ -924,6 +924,36 @@
</glossdef>
</glossentry>
<glossentry id='var-BUILDHISTORY_COMMIT_AUTHOR'><glossterm>BUILDHISTORY_COMMIT_AUTHOR</glossterm>
<glossdef>
<para>
When inheriting the
<link linkend='ref-classes-buildhistory'><filename>buildhistory</filename></link>
class, specifies the author to use for each Git commit.
In order for the <filename>BUILDHISTORY_COMMIT_AUTHOR</filename>
variable to work, the
<link linkend='var-BUILDHISTORY_COMMIT'><filename>BUILDHISTORY_COMMIT</filename></link>
variable must be set to "1".
</para>
<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;".
Providing an email address or host that is not valid does
not produce an error.
</para>
<para>
By default, the <filename>buildhistory</filename> class
sets the variable as follows:
<literallayout class='monospaced'>
BUILDHISTORY_COMMIT_AUTHOR ?= "buildhistory &lt;buildhistory@${DISTRO}&gt;"
</literallayout>
</para>
</glossdef>
</glossentry>
<glossentry id='var-BUILDHISTORY_DIR'><glossterm>BUILDHISTORY_DIR</glossterm>
<glossdef>
<para>