diff options
author | Eli Zaretskii <eliz@gnu.org> | 2024-02-27 15:11:58 +0200 |
---|---|---|
committer | Eli Zaretskii <eliz@gnu.org> | 2024-02-27 15:11:58 +0200 |
commit | 647cecc853e53a3be0bb2cf5328cd19e677217c9 (patch) | |
tree | 8d0ab0f13105f0c300cad10ed59f5b5e14f35ab0 /lisp | |
parent | 383ccf6d51fd7af65dbcc1ce159a03369a48d27f (diff) | |
download | emacs-647cecc853e53a3be0bb2cf5328cd19e677217c9.tar.gz emacs-647cecc853e53a3be0bb2cf5328cd19e677217c9.tar.bz2 emacs-647cecc853e53a3be0bb2cf5328cd19e677217c9.zip |
; * lisp/vc/vc.el (vc-clone): Fix wording of doc string.
Diffstat (limited to 'lisp')
-rw-r--r-- | lisp/vc/vc.el | 15 |
1 files changed, 10 insertions, 5 deletions
diff --git a/lisp/vc/vc.el b/lisp/vc/vc.el index 549eae6e663..25540406b4e 100644 --- a/lisp/vc/vc.el +++ b/lisp/vc/vc.el @@ -3676,11 +3676,16 @@ to provide the `find-revision' operation instead." (vc-call-backend (vc-backend buffer-file-name) 'check-headers)) (defun vc-clone (remote &optional backend directory rev) - "Use BACKEND to clone REMOTE into DIRECTORY. -If successful, returns the string with the directory of the -checkout. If BACKEND is nil, iterate through every known backend -in `vc-handled-backends' until one succeeds. If REV is non-nil, -it indicates a specific revision to check out." + "Clone repository REMOTE using version-control BACKEND, into DIRECTORY. +If successful, return the string with the directory of the checkout; +otherwise return nil. +REMOTE should be a string, the URL of the remote repository or the name +of a directory (if the repository is local). +If DIRECTORY is nil or omitted, it defaults to `default-directory'. +If BACKEND is nil or omitted, the function iterates through every known +backend in `vc-handled-backends' until one succeeds to clone REMOTE. +If REV is non-nil, it indicates a specific revision to check out after +cloning; the syntax of REV depends on what BACKEND accepts." (unless directory (setq directory default-directory)) (if backend |