diff options
Diffstat (limited to 'documentation/ref-manual')
| -rw-r--r-- | documentation/ref-manual/ref-variables.xml | 30 |
1 files changed, 30 insertions, 0 deletions
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 @@ | |||
| 924 | </glossdef> | 924 | </glossdef> |
| 925 | </glossentry> | 925 | </glossentry> |
| 926 | 926 | ||
| 927 | <glossentry id='var-BUILDHISTORY_COMMIT_AUTHOR'><glossterm>BUILDHISTORY_COMMIT_AUTHOR</glossterm> | ||
| 928 | <glossdef> | ||
| 929 | <para> | ||
| 930 | When inheriting the | ||
| 931 | <link linkend='ref-classes-buildhistory'><filename>buildhistory</filename></link> | ||
| 932 | class, specifies the author to use for each Git commit. | ||
| 933 | In order for the <filename>BUILDHISTORY_COMMIT_AUTHOR</filename> | ||
| 934 | variable to work, the | ||
| 935 | <link linkend='var-BUILDHISTORY_COMMIT'><filename>BUILDHISTORY_COMMIT</filename></link> | ||
| 936 | variable must be set to "1". | ||
| 937 | </para> | ||
| 938 | |||
| 939 | <para> | ||
| 940 | Git requires that the value you provide for the | ||
| 941 | <filename>BUILDHISTORY_COMMIT_AUTHOR</filename> variable | ||
| 942 | takes the form of "name <email@host>". | ||
| 943 | Providing an email address or host that is not valid does | ||
| 944 | not produce an error. | ||
| 945 | </para> | ||
| 946 | |||
| 947 | <para> | ||
| 948 | By default, the <filename>buildhistory</filename> class | ||
| 949 | sets the variable as follows: | ||
| 950 | <literallayout class='monospaced'> | ||
| 951 | BUILDHISTORY_COMMIT_AUTHOR ?= "buildhistory <buildhistory@${DISTRO}>" | ||
| 952 | </literallayout> | ||
| 953 | </para> | ||
| 954 | </glossdef> | ||
| 955 | </glossentry> | ||
| 956 | |||
| 927 | <glossentry id='var-BUILDHISTORY_DIR'><glossterm>BUILDHISTORY_DIR</glossterm> | 957 | <glossentry id='var-BUILDHISTORY_DIR'><glossterm>BUILDHISTORY_DIR</glossterm> |
| 928 | <glossdef> | 958 | <glossdef> |
| 929 | <para> | 959 | <para> |
