diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index 3928a1fa42..09e115b410 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml @@ -924,6 +924,36 @@ + BUILDHISTORY_COMMIT_AUTHOR + + + When inheriting the + buildhistory + class, specifies the author to use for each Git commit. + In order for the BUILDHISTORY_COMMIT_AUTHOR + variable to work, the + BUILDHISTORY_COMMIT + variable must be set to "1". + + + + Git requires that the value you provide for the + BUILDHISTORY_COMMIT_AUTHOR variable + takes the form of "name <email@host>". + Providing an email address or host that is not valid does + not produce an error. + + + + By default, the buildhistory class + sets the variable as follows: + + BUILDHISTORY_COMMIT_AUTHOR ?= "buildhistory <buildhistory@${DISTRO}>" + + + + + BUILDHISTORY_DIR