summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMattias Engdegård <mattiase@acm.org>2020-02-28 17:02:00 +0100
committerMattias Engdegård <mattiase@acm.org>2020-02-28 17:03:00 +0100
commit4dec693f703464bab68ec751f341927c5489d592 (patch)
treeb9f13da930c3a5fcac1939e2c2eb62fd7066a9d7
parent696ee02c3a40cf0e19f963cfaf8004ca42f7e897 (diff)
downloademacs-4dec693f703464bab68ec751f341927c5489d592.tar.gz
* lisp/vc/vc-cvs.el (vc-cvs-ignore): Copy-edit doc string
-rw-r--r--lisp/vc/vc-cvs.el21
1 files changed, 11 insertions, 10 deletions
diff --git a/lisp/vc/vc-cvs.el b/lisp/vc/vc-cvs.el
index b6afda69198..e8231ecb289 100644
--- a/lisp/vc/vc-cvs.el
+++ b/lisp/vc/vc-cvs.el
@@ -1222,23 +1222,24 @@ is non-nil."
(defun vc-cvs-ignore (file &optional directory _remove)
"Ignore FILE under CVS.
-FILE is either absolute or relative to DIRECTORY. The basename
-of FILE is written unmodified into the ignore file and is
+FILE is either absolute or relative to DIRECTORY. The non-directory
+part of FILE is written unmodified into the ignore file and is
therefore evaluated by CVS as an ignore pattern which follows
glob(7) syntax. If the pattern should match any of the special
-characters ‘?*[\\\’ literally, they must be escaped with a
+characters `?*[\\' literally, they must be escaped with a
backslash.
CVS processes one ignore file for each subdirectory. Patterns
are separated by whitespace and only match files in the same
directory. Since FILE can be a relative filename with leading
-diretories, FILE is expanded against DIRECTORY to determine the
-correct absolute filename. The directory name of this path is
-then used to determine the location of the ignore file. The base
-name of this path is used as pattern for the ignore file.
-
-Since patterns are whitespace sparated, it is usually better to
-replace spaces in filenames with question marks ‘?’."
+directories, FILE is expanded against DIRECTORY to determine the
+correct absolute filename. The directory part of the resulting name
+is then used to determine the location of the ignore file. The
+non-directory part of the name is used as pattern for the ignore file.
+
+Since patterns are whitespace-separated, filenames containing spaces
+cannot be represented directly. A work-around is to replace such
+spaces with question marks."
(setq file (directory-file-name (expand-file-name file directory)))
(vc-cvs-append-to-ignore (file-name-directory file) (file-name-nondirectory file)))