aboutsummaryrefslogtreecommitdiff
path: root/guix/git.scm
diff options
context:
space:
mode:
authorMaxim Cournoyer <maxim.cournoyer@gmail.com>2023-07-19 22:27:06 -0400
committerMaxim Cournoyer <maxim.cournoyer@gmail.com>2023-08-16 21:34:13 -0400
commitaddffd09884897d8977cd90da09c3bc1c9d2689a (patch)
treea199e5468f2eaf76365eb567520f5e26faf1b505 /guix/git.scm
parent1bd44b425b79e9da160b33a9b19d01973b44772e (diff)
downloadguix-addffd09884897d8977cd90da09c3bc1c9d2689a.tar
guix-addffd09884897d8977cd90da09c3bc1c9d2689a.tar.gz
git: Clarify commit relation reference in doc.
* guix/git.scm (update-cached-checkout): Clarify that it is the relation of STARTING-COMMIT that is returned, relative to the new commit, not the other way around.
Diffstat (limited to 'guix/git.scm')
-rw-r--r--guix/git.scm2
1 files changed, 1 insertions, 1 deletions
diff --git a/guix/git.scm b/guix/git.scm
index be20cde019..dbc3b7caa7 100644
--- a/guix/git.scm
+++ b/guix/git.scm
@@ -439,7 +439,7 @@ could not be fetched from Software Heritage~%")
#:recursive? recursive?)))
"Update the cached checkout of URL to REF in CACHE-DIRECTORY. Return three
values: the cache directory name, and the SHA1 commit (a string) corresponding
-to REF, and the relation of the new commit relative to STARTING-COMMIT (if
+to REF, and the relation of STARTING-COMMIT relative to the new commit (if
provided) as returned by 'commit-relation'.
REF is pair whose key is [branch | commit | tag | tag-or-commit ] and value