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.
parent
1bd44b425b
commit
addffd0988
|
@ -439,7 +439,7 @@ could not be fetched from Software Heritage~%")
|
||||||
#:recursive? recursive?)))
|
#:recursive? recursive?)))
|
||||||
"Update the cached checkout of URL to REF in CACHE-DIRECTORY. Return three
|
"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
|
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'.
|
provided) as returned by 'commit-relation'.
|
||||||
|
|
||||||
REF is pair whose key is [branch | commit | tag | tag-or-commit ] and value
|
REF is pair whose key is [branch | commit | tag | tag-or-commit ] and value
|
||||||
|
|
Reference in New Issue