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.
This commit is contained in:
Maxim Cournoyer 2023-07-19 22:27:06 -04:00
parent 1bd44b425b
commit addffd0988
No known key found for this signature in database
GPG key ID: 1260E46482E63562

View file

@ -439,7 +439,7 @@ (define* (update-cached-checkout url
#: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