diff mbox series

[bug#64737,1/2] git: Clarify commit relation reference in doc.

Message ID ba91013b705bcfd8a6e63c9921aa62ec9ed44283.1689823730.git.maxim.cournoyer@gmail.com
State New
Headers show
Series [bug#64737,1/2] git: Clarify commit relation reference in doc. | expand

Commit Message

Maxim Cournoyer July 20, 2023, 3:28 a.m. UTC 
* 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.
---

 guix/git.scm | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)


base-commit: 1d837aaa32a3a2de8f4a1ac391f92effba50834e
diff mbox series

Patch

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 @@  (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