aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJuanma Barranquero2005-07-20 11:19:10 +0000
committerJuanma Barranquero2005-07-20 11:19:10 +0000
commit0cf1ef266f8fb06eddfd1668467f5d741eb79853 (patch)
tree5f084f854a92e9190a8873c132d7a264bcb9c91c
parent3685c8a4bfbe2a704eff516a6d78b948718021b3 (diff)
downloademacs-0cf1ef266f8fb06eddfd1668467f5d741eb79853.tar.gz
emacs-0cf1ef266f8fb06eddfd1668467f5d741eb79853.zip
(archive-get-descr, archive-alternate-display): Doc fixes.
(archive-l-e): Improve argument/docstring consistency. (archive-tmpdir, archive-unixdate, archive-unixtime, archive-chmod-entry): Fix typos in docstrings. (archive-unflag, archive-unflag-backwards, archive-unmark-all-files): "?\ " -> "?\s".
-rw-r--r--lisp/arc-mode.el26
1 files changed, 13 insertions, 13 deletions
diff --git a/lisp/arc-mode.el b/lisp/arc-mode.el
index b049f8ea734..536160ac366 100644
--- a/lisp/arc-mode.el
+++ b/lisp/arc-mode.el
@@ -131,7 +131,7 @@
131 (make-temp-name 131 (make-temp-name
132 (expand-file-name (if (eq system-type 'ms-dos) "ar" "archive.tmp") 132 (expand-file-name (if (eq system-type 'ms-dos) "ar" "archive.tmp")
133 temporary-file-directory)) 133 temporary-file-directory))
134 "Directory for temporary files made by arc-mode.el." 134 "Directory for temporary files made by `arc-mode.el'."
135 :type 'directory 135 :type 'directory
136 :group 'archive) 136 :group 'archive)
137 137
@@ -465,9 +465,9 @@ Each descriptor is a vector of the form
465 (intern (concat "archive-" (symbol-name archive-subtype) "-" suffix))) 465 (intern (concat "archive-" (symbol-name archive-subtype) "-" suffix)))
466 466
467(defun archive-l-e (str &optional len) 467(defun archive-l-e (str &optional len)
468 "Convert little endian string/vector to integer. 468 "Convert little endian string/vector STR to integer.
469Alternatively, first argument may be a buffer position in the current buffer 469Alternatively, STR may be a buffer position in the current buffer
470in which case a second argument, length, should be supplied." 470in which case a second argument, length LEN, should be supplied."
471 (if (stringp str) 471 (if (stringp str)
472 (setq len (length str)) 472 (setq len (length str))
473 (setq str (buffer-substring str (+ str len)))) 473 (setq str (buffer-substring str (+ str len))))
@@ -567,7 +567,7 @@ the mode is invalid. If ERROR is nil then nil will be returned."
567 (format "%02d:%02d:%02d" hour minute second))) 567 (format "%02d:%02d:%02d" hour minute second)))
568 568
569(defun archive-unixdate (low high) 569(defun archive-unixdate (low high)
570 "Stringify unix (LOW HIGH) date." 570 "Stringify Unix (LOW HIGH) date."
571 (let ((str (current-time-string (cons high low)))) 571 (let ((str (current-time-string (cons high low))))
572 (format "%s-%s-%s" 572 (format "%s-%s-%s"
573 (substring str 8 10) 573 (substring str 8 10)
@@ -575,7 +575,7 @@ the mode is invalid. If ERROR is nil then nil will be returned."
575 (substring str 20 24)))) 575 (substring str 20 24))))
576 576
577(defun archive-unixtime (low high) 577(defun archive-unixtime (low high)
578 "Stringify unix (LOW HIGH) time." 578 "Stringify Unix (LOW HIGH) time."
579 (let ((str (current-time-string (cons high low)))) 579 (let ((str (current-time-string (cons high low))))
580 (substring str 11 19))) 580 (substring str 11 19)))
581 581
@@ -587,7 +587,7 @@ the mode is invalid. If ERROR is nil then nil will be returned."
587 587
588(defun archive-get-descr (&optional noerror) 588(defun archive-get-descr (&optional noerror)
589 "Return the descriptor vector for file at point. 589 "Return the descriptor vector for file at point.
590Does not signal an error if optional second argument NOERROR is non-nil." 590Does not signal an error if optional argument NOERROR is non-nil."
591 (let ((no (archive-get-lineno))) 591 (let ((no (archive-get-lineno)))
592 (if (and (>= (point) archive-file-list-start) 592 (if (and (>= (point) archive-file-list-start)
593 (< no (length archive-files))) 593 (< no (length archive-files)))
@@ -761,7 +761,7 @@ when parsing the archive."
761 761
762(defun archive-alternate-display () 762(defun archive-alternate-display ()
763 "Toggle alternative display. 763 "Toggle alternative display.
764To avoid very long lines some archive mode don't show all information. 764To avoid very long lines archive mode does not show all information.
765This function changes the set of information shown for each files." 765This function changes the set of information shown for each files."
766 (interactive) 766 (interactive)
767 (setq archive-alternate-display (not archive-alternate-display)) 767 (setq archive-alternate-display (not archive-alternate-display))
@@ -1159,13 +1159,13 @@ With a prefix argument, mark that many files."
1159 "In archive mode, un-mark this member if it is marked to be deleted. 1159 "In archive mode, un-mark this member if it is marked to be deleted.
1160With a prefix argument, un-mark that many files forward." 1160With a prefix argument, un-mark that many files forward."
1161 (interactive "p") 1161 (interactive "p")
1162 (archive-flag-deleted p ? )) 1162 (archive-flag-deleted p ?\s))
1163 1163
1164(defun archive-unflag-backwards (p) 1164(defun archive-unflag-backwards (p)
1165 "In archive mode, un-mark this member if it is marked to be deleted. 1165 "In archive mode, un-mark this member if it is marked to be deleted.
1166With a prefix argument, un-mark that many members backward." 1166With a prefix argument, un-mark that many members backward."
1167 (interactive "p") 1167 (interactive "p")
1168 (archive-flag-deleted (- p) ? )) 1168 (archive-flag-deleted (- p) ?\s))
1169 1169
1170(defun archive-unmark-all-files () 1170(defun archive-unmark-all-files ()
1171 "Remove all marks." 1171 "Remove all marks."
@@ -1175,8 +1175,8 @@ With a prefix argument, un-mark that many members backward."
1175 (save-excursion 1175 (save-excursion
1176 (goto-char archive-file-list-start) 1176 (goto-char archive-file-list-start)
1177 (while (< (point) archive-file-list-end) 1177 (while (< (point) archive-file-list-end)
1178 (or (= (following-char) ? ) 1178 (or (= (following-char) ?\s)
1179 (progn (delete-char 1) (insert ? ))) 1179 (progn (delete-char 1) (insert ?\s)))
1180 (forward-line 1))) 1180 (forward-line 1)))
1181 (restore-buffer-modified-p modified))) 1181 (restore-buffer-modified-p modified)))
1182 1182
@@ -1214,7 +1214,7 @@ Use \\[archive-unmark-all-files] to remove all marks."
1214(defun archive-chmod-entry (new-mode) 1214(defun archive-chmod-entry (new-mode)
1215 "Change the protection bits associated with all marked or this member. 1215 "Change the protection bits associated with all marked or this member.
1216The new protection bits can either be specified as an octal number or 1216The new protection bits can either be specified as an octal number or
1217as a relative change like \"g+rw\" as for chmod(2)" 1217as a relative change like \"g+rw\" as for chmod(2)."
1218 (interactive "sNew mode (octal or relative): ") 1218 (interactive "sNew mode (octal or relative): ")
1219 (if archive-read-only (error "Archive is read-only")) 1219 (if archive-read-only (error "Archive is read-only"))
1220 (let ((func (archive-name "chmod-entry"))) 1220 (let ((func (archive-name "chmod-entry")))