~ruther/guix-local

addffd09884897d8977cd90da09c3bc1c9d2689a — Maxim Cournoyer 2 years ago 1bd44b4
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.
1 files changed, 1 insertions(+), 1 deletions(-)

M guix/git.scm
M guix/git.scm => guix/git.scm +1 -1
@@ 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