diff options
| author | Stefan Monnier | 2000-10-04 23:35:52 +0000 |
|---|---|---|
| committer | Stefan Monnier | 2000-10-04 23:35:52 +0000 |
| commit | 616e14f4cf26c2ec2bc06097cae9043a2f0118ec (patch) | |
| tree | 33c49854a2e42038f2122a5fb7e49b8fda374ee0 | |
| parent | 38ab866cad7982a1191dce83acd4b539287b16fe (diff) | |
| download | emacs-616e14f4cf26c2ec2bc06097cae9043a2f0118ec.tar.gz emacs-616e14f4cf26c2ec2bc06097cae9043a2f0118ec.zip | |
(dired-do-create-files, dired-kill-tree): Turn comment into docstring.
| -rw-r--r-- | lisp/dired-aux.el | 78 |
1 files changed, 39 insertions, 39 deletions
diff --git a/lisp/dired-aux.el b/lisp/dired-aux.el index 5c38c68ff97..b543dc9edd5 100644 --- a/lisp/dired-aux.el +++ b/lisp/dired-aux.el | |||
| @@ -1185,43 +1185,43 @@ ESC or `q' to not overwrite any of the remaining files, | |||
| 1185 | (dired-move-to-filename)) | 1185 | (dired-move-to-filename)) |
| 1186 | 1186 | ||
| 1187 | (defun dired-do-create-files (op-symbol file-creator operation arg | 1187 | (defun dired-do-create-files (op-symbol file-creator operation arg |
| 1188 | &optional marker-char op1 | 1188 | &optional marker-char op1 |
| 1189 | how-to) | 1189 | how-to) |
| 1190 | ;; Create a new file for each marked file. | 1190 | "Create a new file for each marked file. |
| 1191 | ;; Prompts user for target, which is a directory in which to create | 1191 | Prompts user for target, which is a directory in which to create |
| 1192 | ;; the new files. Target may be a plain file if only one marked | 1192 | the new files. Target may be a plain file if only one marked |
| 1193 | ;; file exists. | 1193 | file exists. |
| 1194 | ;; OP-SYMBOL is the symbol for the operation. Function `dired-mark-pop-up' | 1194 | OP-SYMBOL is the symbol for the operation. Function `dired-mark-pop-up' |
| 1195 | ;; will determine whether pop-ups are appropriate for this OP-SYMBOL. | 1195 | will determine whether pop-ups are appropriate for this OP-SYMBOL. |
| 1196 | ;; FILE-CREATOR and OPERATION as in dired-create-files. | 1196 | FILE-CREATOR and OPERATION as in `dired-create-files'. |
| 1197 | ;; ARG as in dired-get-marked-files. | 1197 | ARG as in `dired-get-marked-files'. |
| 1198 | ;; Optional arg MARKER-CHAR as in dired-create-files. | 1198 | Optional arg MARKER-CHAR as in `dired-create-files'. |
| 1199 | ;; Optional arg OP1 is an alternate form for OPERATION if there is | 1199 | Optional arg OP1 is an alternate form for OPERATION if there is |
| 1200 | ;; only one file. | 1200 | only one file. |
| 1201 | ;; Optional arg HOW-TO is used to set the value of the into-dir variable | 1201 | Optional arg HOW-TO is used to set the value of the into-dir variable |
| 1202 | ;; which determines how to treat target. | 1202 | which determines how to treat target. |
| 1203 | ;; If into-dir is set to nil then target is not regarded as a directory, | 1203 | If into-dir is set to nil then target is not regarded as a directory, |
| 1204 | ;; there must be exactly one marked file, else error. | 1204 | there must be exactly one marked file, else error. |
| 1205 | ;; Else if into-dir is set to a list, then target is a genearlized | 1205 | Else if into-dir is set to a list, then target is a generalized |
| 1206 | ;; directory (e.g. some sort of archive). The first element of into-dir | 1206 | directory (e.g. some sort of archive). The first element of into-dir |
| 1207 | ;; must be a function with at least four arguments: | 1207 | must be a function with at least four arguments: |
| 1208 | ;; operation as OPERATION above. | 1208 | operation as OPERATION above. |
| 1209 | ;; rfn-list a list of the relative names for the marked files. | 1209 | rfn-list a list of the relative names for the marked files. |
| 1210 | ;; fn-list a list of the absolute names for the marked files. | 1210 | fn-list a list of the absolute names for the marked files. |
| 1211 | ;; target. | 1211 | target. |
| 1212 | ;; The rest of into-dir are optional arguments. | 1212 | The rest of into-dir are optional arguments. |
| 1213 | ;; Else into-dir is not a list. Target is a directory. | 1213 | Else into-dir is not a list. Target is a directory. |
| 1214 | ;; The marked file(s) are created inside the target directory. | 1214 | The marked file(s) are created inside the target directory. |
| 1215 | ;; | 1215 | |
| 1216 | ;; If HOW-TO is not given (or nil), then into-dir is set to true if | 1216 | If HOW-TO is not given (or nil), then into-dir is set to true if |
| 1217 | ;; target is a directory and otherwise to nil. | 1217 | target is a directory and otherwise to nil. |
| 1218 | ;; Else if HOW-TO is t, then into-dir is set to nil. | 1218 | Else if HOW-TO is t, then into-dir is set to nil. |
| 1219 | ;; Else HOW-TO is assumed to be a function of one argument, target, | 1219 | Else HOW-TO is assumed to be a function of one argument, target, |
| 1220 | ;; that looks at target and returns a value for the into-dir | 1220 | that looks at target and returns a value for the into-dir |
| 1221 | ;; variable. The function dired-into-dir-with-symlinks is provided | 1221 | variable. The function `dired-into-dir-with-symlinks' is provided |
| 1222 | ;; for the case (common when creating symlinks) that symbolic | 1222 | for the case (common when creating symlinks) that symbolic |
| 1223 | ;; links to directories are not to be considered as directories | 1223 | links to directories are not to be considered as directories |
| 1224 | ;; (as file-directory-p would if HOW-TO had been nil). | 1224 | (as `file-directory-p' would if HOW-TO had been nil)." |
| 1225 | (or op1 (setq op1 operation)) | 1225 | (or op1 (setq op1 operation)) |
| 1226 | (let* ((fn-list (dired-get-marked-files nil arg)) | 1226 | (let* ((fn-list (dired-get-marked-files nil arg)) |
| 1227 | (rfn-list (mapcar (function dired-make-relative) fn-list)) | 1227 | (rfn-list (mapcar (function dired-make-relative) fn-list)) |
| @@ -1640,8 +1640,8 @@ This function takes some pains to conform to `ls -lR' output." | |||
| 1640 | (dired-get-subdir-min elt2))))))) | 1640 | (dired-get-subdir-min elt2))))))) |
| 1641 | 1641 | ||
| 1642 | (defun dired-kill-tree (dirname &optional remember-marks) | 1642 | (defun dired-kill-tree (dirname &optional remember-marks) |
| 1643 | ;;"Kill all proper subdirs of DIRNAME, excluding DIRNAME itself. | 1643 | "Kill all proper subdirs of DIRNAME, excluding DIRNAME itself. |
| 1644 | ;; With optional arg REMEMBER-MARKS, return an alist of marked files." | 1644 | With optional arg REMEMBER-MARKS, return an alist of marked files." |
| 1645 | (interactive "DKill tree below directory: ") | 1645 | (interactive "DKill tree below directory: ") |
| 1646 | (setq dirname (expand-file-name dirname)) | 1646 | (setq dirname (expand-file-name dirname)) |
| 1647 | (let ((s-alist dired-subdir-alist) dir m-alist) | 1647 | (let ((s-alist dired-subdir-alist) dir m-alist) |