From ab83e1f054ef8c9ce1486a56f2484430630d42a3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ludovic=20Court=C3=A8s?= Date: Mon, 22 Jun 2020 16:35:39 +0200 Subject: [PATCH] doc: cookbook: Clarify 'git-fetch' conventions. * doc/guix-cookbook.texi (Extended example): Clarify use of 'git-file-name' and 'git-version'. --- doc/guix-cookbook.texi | 10 ++++++---- 1 file 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