diff options
| author | Ludovic Courtès <ludo@gnu.org> | 2020-06-22 16:35:39 +0200 |
|---|---|---|
| committer | Ludovic Courtès <ludo@gnu.org> | 2020-06-23 00:03:08 +0200 |
| commit | ab83e1f054ef8c9ce1486a56f2484430630d42a3 (patch) | |
| tree | 5489d15b849abea7c2d1da06ec43b63e6692b399 /doc | |
| parent | 62115b7ab741fd6d10038721d23140d8919d8ab7 (diff) | |
| download | guix-patches-ab83e1f054ef8c9ce1486a56f2484430630d42a3.tar guix-patches-ab83e1f054ef8c9ce1486a56f2484430630d42a3.tar.gz | |
doc: cookbook: Clarify 'git-fetch' conventions.
* doc/guix-cookbook.texi (Extended example): Clarify use of 'git-file-name'
and 'git-version'.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/guix-cookbook.texi | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/doc/guix-cookbook.texi b/doc/guix-cookbook.texi index 1342826c97..31c4cd4121 100644 --- a/doc/guix-cookbook.texi +++ b/doc/guix-cookbook.texi @@ -843,12 +843,14 @@ tags, so if the @code{version} is tagged, then it can be used directly. Sometim the tag is prefixed with a @code{v}, in which case you'd use @code{(commit (string-append "v" version))}. -To ensure that the source code from the Git repository is stored in a unique -directory with a readable name we use @code{(file-name (git-file-name name +To ensure that the source code from the Git repository is stored in a +directory with a descriptive name, we use @code{(file-name (git-file-name name version))}. -Note that there is also a @code{git-version} procedure that can be used to derive the -version when packaging programs for a specific commit. +The @code{git-version} procedure that can be used to derive the +version when packaging programs for a specific commit, following the +Guix contributor guidelines (@pxref{Version Numbers,,, guix, GNU Guix +Reference Manual}). @subsubsection Snippets |