diff options
| author | Kim F. Storm | 2003-01-14 23:11:19 +0000 |
|---|---|---|
| committer | Kim F. Storm | 2003-01-14 23:11:19 +0000 |
| commit | 470fa6d1a1e88da01337266497d25594b8a1dd5a (patch) | |
| tree | 9264f71d80d70bbaba9f56727f231d54e0b24745 /lisp | |
| parent | af3f4952e5944f0d66cc72d2535fa08fadfa20c5 (diff) | |
| download | emacs-470fa6d1a1e88da01337266497d25594b8a1dd5a.tar.gz emacs-470fa6d1a1e88da01337266497d25594b8a1dd5a.zip | |
Doc fixes.
Diffstat (limited to 'lisp')
| -rw-r--r-- | lisp/dired-x.el | 18 | ||||
| -rw-r--r-- | lisp/dired.el | 21 |
2 files changed, 19 insertions, 20 deletions
diff --git a/lisp/dired-x.el b/lisp/dired-x.el index bfc15abf022..6f0384be784 100644 --- a/lisp/dired-x.el +++ b/lisp/dired-x.el | |||
| @@ -7,7 +7,7 @@ | |||
| 7 | ;; Date: 1994/08/18 19:27:42 | 7 | ;; Date: 1994/08/18 19:27:42 |
| 8 | ;; Keywords: dired extensions files | 8 | ;; Keywords: dired extensions files |
| 9 | 9 | ||
| 10 | ;; Copyright (C) 1993, 1994, 1997, 2001 Free Software Foundation, Inc. | 10 | ;; Copyright (C) 1993, 1994, 1997, 2001, 2003 Free Software Foundation, Inc. |
| 11 | 11 | ||
| 12 | ;; This file is part of GNU Emacs. | 12 | ;; This file is part of GNU Emacs. |
| 13 | 13 | ||
| @@ -470,8 +470,8 @@ buffer and try again." | |||
| 470 | (defvar dired-omit-localp 'no-dir | 470 | (defvar dired-omit-localp 'no-dir |
| 471 | "The LOCALP argument `dired-omit-expunge' passes to `dired-get-filename'. | 471 | "The LOCALP argument `dired-omit-expunge' passes to `dired-get-filename'. |
| 472 | If it is 'no-dir, omitting is much faster, but you can only match | 472 | If it is 'no-dir, omitting is much faster, but you can only match |
| 473 | against the basename of the file. Set it to nil if you need to match the | 473 | against the non-directory part of the file name. Set it to nil if you |
| 474 | whole pathname.") | 474 | need to match the entire file name.") |
| 475 | 475 | ||
| 476 | ;; \017=^O for Omit - other packages can chose other control characters. | 476 | ;; \017=^O for Omit - other packages can chose other control characters. |
| 477 | (defvar dired-omit-marker-char ?\017 | 477 | (defvar dired-omit-marker-char ?\017 |
| @@ -570,7 +570,7 @@ This functions works by temporarily binding `dired-marker-char' to | |||
| 570 | ;; Returns t if any work was done, nil otherwise. | 570 | ;; Returns t if any work was done, nil otherwise. |
| 571 | (defun dired-mark-unmarked-files (regexp msg &optional unflag-p localp) | 571 | (defun dired-mark-unmarked-files (regexp msg &optional unflag-p localp) |
| 572 | "Mark unmarked files matching REGEXP, displaying MSG. | 572 | "Mark unmarked files matching REGEXP, displaying MSG. |
| 573 | REGEXP is matched against the complete pathname. | 573 | REGEXP is matched against the entire file name. |
| 574 | Does not re-mark files which already have a mark. | 574 | Does not re-mark files which already have a mark. |
| 575 | With prefix argument, unflag all those files. | 575 | With prefix argument, unflag all those files. |
| 576 | Second optional argument LOCALP is as in `dired-get-filename'." | 576 | Second optional argument LOCALP is as in `dired-get-filename'." |
| @@ -1122,7 +1122,7 @@ results in | |||
| 1122 | file2 (expand-file-name file2) | 1122 | file2 (expand-file-name file2) |
| 1123 | len1 (length file1) | 1123 | len1 (length file1) |
| 1124 | len2 (length file2)) | 1124 | len2 (length file2)) |
| 1125 | ;; Find common initial pathname components: | 1125 | ;; Find common initial file name components: |
| 1126 | (let (next) | 1126 | (let (next) |
| 1127 | (while (and (setq next (string-match "/" file1 index)) | 1127 | (while (and (setq next (string-match "/" file1 index)) |
| 1128 | (setq next (1+ next)) | 1128 | (setq next (1+ next)) |
| @@ -1140,7 +1140,7 @@ results in | |||
| 1140 | sub (substring file1 0 index) | 1140 | sub (substring file1 0 index) |
| 1141 | name1 (substring file1 index))) | 1141 | name1 (substring file1 index))) |
| 1142 | (if (string-equal sub "/") | 1142 | (if (string-equal sub "/") |
| 1143 | ;; No common initial pathname found | 1143 | ;; No common initial file name found |
| 1144 | (setq name1 file1) | 1144 | (setq name1 file1) |
| 1145 | ;; Else they have a common parent directory | 1145 | ;; Else they have a common parent directory |
| 1146 | (let ((tem (substring file2 index)) | 1146 | (let ((tem (substring file2 index)) |
| @@ -1168,19 +1168,19 @@ This creates relative symbolic links like | |||
| 1168 | 1168 | ||
| 1169 | not absolute ones like | 1169 | not absolute ones like |
| 1170 | 1170 | ||
| 1171 | foo -> /ugly/path/that/may/change/any/day/bar/foo" | 1171 | foo -> /ugly/file/name/that/may/change/any/day/bar/foo" |
| 1172 | (interactive "P") | 1172 | (interactive "P") |
| 1173 | (dired-do-create-files 'relsymlink (function dired-make-relative-symlink) | 1173 | (dired-do-create-files 'relsymlink (function dired-make-relative-symlink) |
| 1174 | "RelSymLink" arg dired-keep-marker-relsymlink)) | 1174 | "RelSymLink" arg dired-keep-marker-relsymlink)) |
| 1175 | 1175 | ||
| 1176 | (defun dired-do-relsymlink-regexp (regexp newname &optional whole-path) | 1176 | (defun dired-do-relsymlink-regexp (regexp newname &optional whole-name) |
| 1177 | "RelSymlink all marked files containing REGEXP to NEWNAME. | 1177 | "RelSymlink all marked files containing REGEXP to NEWNAME. |
| 1178 | See functions `dired-do-rename-regexp' and `dired-do-relsymlink' | 1178 | See functions `dired-do-rename-regexp' and `dired-do-relsymlink' |
| 1179 | for more info." | 1179 | for more info." |
| 1180 | (interactive (dired-mark-read-regexp "RelSymLink")) | 1180 | (interactive (dired-mark-read-regexp "RelSymLink")) |
| 1181 | (dired-do-create-files-regexp | 1181 | (dired-do-create-files-regexp |
| 1182 | (function dired-make-relative-symlink) | 1182 | (function dired-make-relative-symlink) |
| 1183 | "RelSymLink" nil regexp newname whole-path dired-keep-marker-relsymlink)) | 1183 | "RelSymLink" nil regexp newname whole-name dired-keep-marker-relsymlink)) |
| 1184 | 1184 | ||
| 1185 | 1185 | ||
| 1186 | ;;; VISIT ALL MARKED FILES SIMULTANEOUSLY. | 1186 | ;;; VISIT ALL MARKED FILES SIMULTANEOUSLY. |
diff --git a/lisp/dired.el b/lisp/dired.el index 160fee7d34b..c504e7a1185 100644 --- a/lisp/dired.el +++ b/lisp/dired.el | |||
| @@ -1,6 +1,6 @@ | |||
| 1 | ;;; dired.el --- directory-browsing commands | 1 | ;;; dired.el --- directory-browsing commands |
| 2 | 2 | ||
| 3 | ;; Copyright (C) 1985, 86, 92, 93, 94, 95, 96, 1997, 2000, 2001 | 3 | ;; Copyright (C) 1985, 86, 92, 93, 94, 95, 96, 1997, 2000, 2001, 2003 |
| 4 | ;; Free Software Foundation, Inc. | 4 | ;; Free Software Foundation, Inc. |
| 5 | 5 | ||
| 6 | ;; Author: Sebastian Kremer <sk@thp.uni-koeln.de> | 6 | ;; Author: Sebastian Kremer <sk@thp.uni-koeln.de> |
| @@ -59,7 +59,7 @@ some of the `ls' switches are not supported; see the doc string of | |||
| 59 | :type 'string | 59 | :type 'string |
| 60 | :group 'dired) | 60 | :group 'dired) |
| 61 | 61 | ||
| 62 | ; Don't use absolute paths as /bin should be in any PATH and people | 62 | ; Don't use absolute file names as /bin should be in any PATH and people |
| 63 | ; may prefer /usr/local/gnu/bin or whatever. However, chown is | 63 | ; may prefer /usr/local/gnu/bin or whatever. However, chown is |
| 64 | ; usually not in PATH. | 64 | ; usually not in PATH. |
| 65 | 65 | ||
| @@ -1517,7 +1517,7 @@ Optional arg GLOBAL means to replace all matches." | |||
| 1517 | (replace-match newtext t literal string)))) | 1517 | (replace-match newtext t literal string)))) |
| 1518 | 1518 | ||
| 1519 | (defun dired-make-absolute (file &optional dir) | 1519 | (defun dired-make-absolute (file &optional dir) |
| 1520 | ;;"Convert FILE (a pathname relative to DIR) to an absolute pathname." | 1520 | ;;"Convert FILE (a file name relative to DIR) to an absolute file name." |
| 1521 | ;; We can't always use expand-file-name as this would get rid of `.' | 1521 | ;; We can't always use expand-file-name as this would get rid of `.' |
| 1522 | ;; or expand in / instead default-directory if DIR=="". | 1522 | ;; or expand in / instead default-directory if DIR=="". |
| 1523 | ;; This should be good enough for ange-ftp, but might easily be | 1523 | ;; This should be good enough for ange-ftp, but might easily be |
| @@ -1679,8 +1679,8 @@ regardless of the language.") | |||
| 1679 | (defun dired-copy-filename-as-kill (&optional arg) | 1679 | (defun dired-copy-filename-as-kill (&optional arg) |
| 1680 | "Copy names of marked (or next ARG) files into the kill ring. | 1680 | "Copy names of marked (or next ARG) files into the kill ring. |
| 1681 | The names are separated by a space. | 1681 | The names are separated by a space. |
| 1682 | With a zero prefix arg, use the complete pathname of each marked file. | 1682 | With a zero prefix arg, use the absolute file name of each marked file. |
| 1683 | With \\[universal-argument], use the relative pathname of each marked file. | 1683 | With \\[universal-argument], use the file name sans directory of each marked file. |
| 1684 | 1684 | ||
| 1685 | If on a subdir headerline, use subdirname instead; prefix arg is ignored | 1685 | If on a subdir headerline, use subdirname instead; prefix arg is ignored |
| 1686 | in this case. | 1686 | in this case. |
| @@ -1799,8 +1799,8 @@ You can then feed the file name(s) to other commands with \\[yank]." | |||
| 1799 | (string-match (concat "^" (regexp-quote dir)) file))) | 1799 | (string-match (concat "^" (regexp-quote dir)) file))) |
| 1800 | 1800 | ||
| 1801 | (defun dired-normalize-subdir (dir) | 1801 | (defun dired-normalize-subdir (dir) |
| 1802 | ;; Prepend default-directory to DIR if relative path name. | 1802 | ;; Prepend default-directory to DIR if relative file name. |
| 1803 | ;; dired-get-filename must be able to make a valid filename from a | 1803 | ;; dired-get-filename must be able to make a valid file name from a |
| 1804 | ;; file and its directory DIR. | 1804 | ;; file and its directory DIR. |
| 1805 | (file-name-as-directory | 1805 | (file-name-as-directory |
| 1806 | (if (file-name-absolute-p dir) | 1806 | (if (file-name-absolute-p dir) |
| @@ -1944,7 +1944,7 @@ instead of `dired-actual-switches'." | |||
| 1944 | (defun dired-goto-file (file) | 1944 | (defun dired-goto-file (file) |
| 1945 | "Go to file line of FILE in this dired buffer." | 1945 | "Go to file line of FILE in this dired buffer." |
| 1946 | ;; Return value of point on success, else nil. | 1946 | ;; Return value of point on success, else nil. |
| 1947 | ;; FILE must be an absolute pathname. | 1947 | ;; FILE must be an absolute file name. |
| 1948 | ;; Loses if FILE contains control chars like "\007" for which ls | 1948 | ;; Loses if FILE contains control chars like "\007" for which ls |
| 1949 | ;; either inserts "?" or "\\007" into the buffer, so we won't find | 1949 | ;; either inserts "?" or "\\007" into the buffer, so we won't find |
| 1950 | ;; it in the buffer. | 1950 | ;; it in the buffer. |
| @@ -2992,9 +2992,8 @@ As each match is found, the user must type a character saying | |||
| 2992 | what to do with it. For directions, type \\[help-command] at that time. | 2992 | what to do with it. For directions, type \\[help-command] at that time. |
| 2993 | NEWNAME may contain \\=\\<n> or \\& as in `query-replace-regexp'. | 2993 | NEWNAME may contain \\=\\<n> or \\& as in `query-replace-regexp'. |
| 2994 | REGEXP defaults to the last regexp used. | 2994 | REGEXP defaults to the last regexp used. |
| 2995 | With a zero prefix arg, renaming by regexp affects the complete | 2995 | With a zero prefix arg, renaming by regexp affects the full file name; |
| 2996 | pathname - usually only the non-directory part of file names is used | 2996 | usually only the non-directory part of file names is used and changed." |
| 2997 | and changed." | ||
| 2998 | t) | 2997 | t) |
| 2999 | 2998 | ||
| 3000 | (autoload 'dired-do-copy-regexp "dired-aux" | 2999 | (autoload 'dired-do-copy-regexp "dired-aux" |