diff mbox series

[bug#64746,v2,1/3] git: Clarify commit relation reference in doc.

Message ID 340786ccd3d40c0c8906028dc20af5ae9b0aa6b9.1692128648.git.maxim.cournoyer@gmail.com
State New
Headers show
Series [bug#64746,v2,1/3] git: Clarify commit relation reference in doc. | expand

Commit Message

Maxim Cournoyer Aug. 15, 2023, 7:44 p.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.
---

(no changes since v1)

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


base-commit: a4bed14c438dc0cbc1c1885a38f8409c7fef7957
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