From 470fa6d1a1e88da01337266497d25594b8a1dd5a Mon Sep 17 00:00:00 2001 From: "Kim F. Storm" Date: Tue, 14 Jan 2003 23:11:19 +0000 Subject: [PATCH] Doc fixes. --- lisp/dired-x.el | 18 +++++++++--------- 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 @@ ;; Date: 1994/08/18 19:27:42 ;; Keywords: dired extensions files -;; Copyright (C) 1993, 1994, 1997, 2001 Free Software Foundation, Inc. +;; Copyright (C) 1993, 1994, 1997, 2001, 2003 Free Software Foundation, Inc. ;; This file is part of GNU Emacs. @@ -470,8 +470,8 @@ buffer and try again." (defvar dired-omit-localp 'no-dir "The LOCALP argument `dired-omit-expunge' passes to `dired-get-filename'. If it is 'no-dir, omitting is much faster, but you can only match -against the basename of the file. Set it to nil if you need to match the -whole pathname.") +against the non-directory part of the file name. Set it to nil if you +need to match the entire file name.") ;; \017=^O for Omit - other packages can chose other control characters. (defvar dired-omit-marker-char ?\017 @@ -570,7 +570,7 @@ This functions works by temporarily binding `dired-marker-char' to ;; Returns t if any work was done, nil otherwise. (defun dired-mark-unmarked-files (regexp msg &optional unflag-p localp) "Mark unmarked files matching REGEXP, displaying MSG. -REGEXP is matched against the complete pathname. +REGEXP is matched against the entire file name. Does not re-mark files which already have a mark. With prefix argument, unflag all those files. Second optional argument LOCALP is as in `dired-get-filename'." @@ -1122,7 +1122,7 @@ results in file2 (expand-file-name file2) len1 (length file1) len2 (length file2)) - ;; Find common initial pathname components: + ;; Find common initial file name components: (let (next) (while (and (setq next (string-match "/" file1 index)) (setq next (1+ next)) @@ -1140,7 +1140,7 @@ results in sub (substring file1 0 index) name1 (substring file1 index))) (if (string-equal sub "/") - ;; No common initial pathname found + ;; No common initial file name found (setq name1 file1) ;; Else they have a common parent directory (let ((tem (substring file2 index)) @@ -1168,19 +1168,19 @@ This creates relative symbolic links like not absolute ones like - foo -> /ugly/path/that/may/change/any/day/bar/foo" + foo -> /ugly/file/name/that/may/change/any/day/bar/foo" (interactive "P") (dired-do-create-files 'relsymlink (function dired-make-relative-symlink) "RelSymLink" arg dired-keep-marker-relsymlink)) -(defun dired-do-relsymlink-regexp (regexp newname &optional whole-path) +(defun dired-do-relsymlink-regexp (regexp newname &optional whole-name) "RelSymlink all marked files containing REGEXP to NEWNAME. See functions `dired-do-rename-regexp' and `dired-do-relsymlink' for more info." (interactive (dired-mark-read-regexp "RelSymLink")) (dired-do-create-files-regexp (function dired-make-relative-symlink) - "RelSymLink" nil regexp newname whole-path dired-keep-marker-relsymlink)) + "RelSymLink" nil regexp newname whole-name dired-keep-marker-relsymlink)) ;;; 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 @@ ;;; dired.el --- directory-browsing commands -;; Copyright (C) 1985, 86, 92, 93, 94, 95, 96, 1997, 2000, 2001 +;; Copyright (C) 1985, 86, 92, 93, 94, 95, 96, 1997, 2000, 2001, 2003 ;; Free Software Foundation, Inc. ;; Author: Sebastian Kremer @@ -59,7 +59,7 @@ some of the `ls' switches are not supported; see the doc string of :type 'string :group 'dired) -; Don't use absolute paths as /bin should be in any PATH and people +; Don't use absolute file names as /bin should be in any PATH and people ; may prefer /usr/local/gnu/bin or whatever. However, chown is ; usually not in PATH. @@ -1517,7 +1517,7 @@ Optional arg GLOBAL means to replace all matches." (replace-match newtext t literal string)))) (defun dired-make-absolute (file &optional dir) - ;;"Convert FILE (a pathname relative to DIR) to an absolute pathname." + ;;"Convert FILE (a file name relative to DIR) to an absolute file name." ;; We can't always use expand-file-name as this would get rid of `.' ;; or expand in / instead default-directory if DIR=="". ;; This should be good enough for ange-ftp, but might easily be @@ -1679,8 +1679,8 @@ regardless of the language.") (defun dired-copy-filename-as-kill (&optional arg) "Copy names of marked (or next ARG) files into the kill ring. The names are separated by a space. -With a zero prefix arg, use the complete pathname of each marked file. -With \\[universal-argument], use the relative pathname of each marked file. +With a zero prefix arg, use the absolute file name of each marked file. +With \\[universal-argument], use the file name sans directory of each marked file. If on a subdir headerline, use subdirname instead; prefix arg is ignored in this case. @@ -1799,8 +1799,8 @@ You can then feed the file name(s) to other commands with \\[yank]." (string-match (concat "^" (regexp-quote dir)) file))) (defun dired-normalize-subdir (dir) - ;; Prepend default-directory to DIR if relative path name. - ;; dired-get-filename must be able to make a valid filename from a + ;; Prepend default-directory to DIR if relative file name. + ;; dired-get-filename must be able to make a valid file name from a ;; file and its directory DIR. (file-name-as-directory (if (file-name-absolute-p dir) @@ -1944,7 +1944,7 @@ instead of `dired-actual-switches'." (defun dired-goto-file (file) "Go to file line of FILE in this dired buffer." ;; Return value of point on success, else nil. - ;; FILE must be an absolute pathname. + ;; FILE must be an absolute file name. ;; Loses if FILE contains control chars like "\007" for which ls ;; either inserts "?" or "\\007" into the buffer, so we won't find ;; it in the buffer. @@ -2992,9 +2992,8 @@ As each match is found, the user must type a character saying what to do with it. For directions, type \\[help-command] at that time. NEWNAME may contain \\=\\ or \\& as in `query-replace-regexp'. REGEXP defaults to the last regexp used. -With a zero prefix arg, renaming by regexp affects the complete - pathname - usually only the non-directory part of file names is used - and changed." +With a zero prefix arg, renaming by regexp affects the full file name; +usually only the non-directory part of file names is used and changed." t) (autoload 'dired-do-copy-regexp "dired-aux"