gwh/slackbuilds
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fix a bunch of checkdoc warnings.

Browse source 
This only fixes the easy warnings. Harder stuff like documenting
undocumented functions or making sure all the arguments of each
function are documented is not done.
This commit is contained in:
Nathan Weizenbaum 2010-06-06 04:13:15 -07:00
parent 448ef5cf64
commit 00569b85f2
1 changed files with 59 additions and 52 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

111
magit.el
View file

@ -88,12 +88,15 @@
(defcustom magit-repo-dirs nil (defcustom magit-repo-dirs nil
"Directories containing Git repositories. "Directories containing Git repositories.
Magit will look into these directories for Git repositories and offers them as choices for `magit-status'." Magit will look into these directories for Git repositories and
offer them as choices for `magit-status'."
:group 'magit :group 'magit
:type '(repeat string)) :type '(repeat string))
(defcustom magit-repo-dirs-depth 3 (defcustom magit-repo-dirs-depth 3
"When looking for Git repository below the directories in `magit-repo-dirs', Magit will only descend this many levels deep." "The maximum depth to look for Git repos.
When looking for a Git repository below the directories in `magit-repo-dirs',
Magit will only descend this many levels deep."
:group 'magit :group 'magit
:type 'integer) :type 'integer)
@ -108,7 +111,11 @@ save all modified buffers without asking."
(defcustom magit-commit-all-when-nothing-staged 'ask (defcustom magit-commit-all-when-nothing-staged 'ask
"Determines what \\[magit-log-edit] does when nothing is staged. "Determines what \\[magit-log-edit] does when nothing is staged.
Setting this to nil will make it do nothing, setting it to t will arrange things so that the actual commit command will use the \"--all\" option, setting it to 'ask will first ask for confirmation whether to do this, and setting it to 'ask-stage will cause all changes to be staged, after a confirmation." Setting this to nil will make it do nothing, setting it to t will
arrange things so that the actual commit command will use the \"--all\" option,
setting it to 'ask will first ask for confirmation whether to do this,
and setting it to 'ask-stage will cause all changes to be staged,
after a confirmation."
:group 'magit :group 'magit
:type '(choice (const :tag "No" nil) :type '(choice (const :tag "No" nil)
(const :tag "Always" t) (const :tag "Always" t)
@ -126,7 +133,7 @@ Setting this to nil will make it do nothing, setting it to t will arrange things
:type 'integer) :type 'integer)
(defcustom magit-log-infinite-length 99999 (defcustom magit-log-infinite-length 99999
"Number of log used to show as maximum for magit-log-cutoff-length" "Number of log used to show as maximum for `magit-log-cutoff-length'."
:group 'magit :group 'magit
:type 'integer) :type 'integer)
@ -138,7 +145,7 @@ Setting this to nil will make it do nothing, setting it to t will arrange things
(integer :tag "After this many seconds"))) (integer :tag "After this many seconds")))
(defcustom magit-revert-item-confirm nil (defcustom magit-revert-item-confirm nil
"Require acknowledgment before reverting an item" "Require acknowledgment before reverting an item."
:group 'magit :group 'magit
:type 'boolean) :type 'boolean)
@ -740,14 +747,14 @@ If TYPE is nil, the section won't be highlighted."
(magit-propertize-section s))) (magit-propertize-section s)))
(defun magit-find-section (path top) (defun magit-find-section (path top)
"Find in subsection of section TOP the section at the path PATH." "Find the section at the path PATH in subsection of section TOP."
(if (null path) (if (null path)
top top
(let ((secs (magit-section-children top))) (let ((secs (magit-section-children top)))
(while (and secs (not (equal (car path) (while (and secs (not (equal (car path)
(magit-section-title (car secs))))) (magit-section-title (car secs)))))
(setq secs (cdr secs))) (setq secs (cdr secs)))
(and (car secs) (and (car secs)
(magit-find-section (cdr path) (car secs)))))) (magit-find-section (cdr path) (car secs))))))
(defun magit-section-path (section) (defun magit-section-path (section)
@ -771,14 +778,14 @@ If TYPE is nil, the section won't be highlighted."
nil)) nil))
(defun magit-find-section-after (pos secs) (defun magit-find-section-after (pos secs)
"Find the first section in the list SECS that begin after POS." "Find the first section that begins after POS in the list SECS."
(while (and secs (while (and secs
(not (> (magit-section-beginning (car secs)) pos))) (not (> (magit-section-beginning (car secs)) pos)))
(setq secs (cdr secs))) (setq secs (cdr secs)))
(car secs)) (car secs))
(defun magit-find-section-before (pos secs) (defun magit-find-section-before (pos secs)
"Find the last section in the list SECS that begin before POS." "Find the last section that begins before POS in the list SECS."
(let ((prev nil)) (let ((prev nil))
(while (and secs (while (and secs
(not (> (magit-section-beginning (car secs)) pos))) (not (> (magit-section-beginning (car secs)) pos)))
@ -1019,7 +1026,7 @@ IF FLAG-OR-FUNC is a Boolean value, the section will be hidden if its true, show
(magit-section-hideshow #'magit-section-expand)) (magit-section-hideshow #'magit-section-expand))
(defun magit-toggle-file-section () (defun magit-toggle-file-section ()
"Like `magit-toggle-section' but toggles at file granularity." "Like `magit-toggle-section' but toggle at file granularity."
(interactive) (interactive)
(when (eq 'hunk (first (magit-section-context-type (magit-current-section)))) (when (eq 'hunk (first (magit-section-context-type (magit-current-section))))
(magit-goto-parent-section)) (magit-goto-parent-section))
@ -1242,7 +1249,7 @@ FUNC should leave point at the end of the modified region"
(defvar magit-process nil) (defvar magit-process nil)
(defvar magit-process-client-buffer nil) (defvar magit-process-client-buffer nil)
(defvar magit-process-buffer-name "*magit-process*" (defvar magit-process-buffer-name "*magit-process*"
"Buffer name for running git commands") "Buffer name for running git commands.")
(defun magit-run* (cmd-and-args (defun magit-run* (cmd-and-args
&optional logline noerase noerror nowait input) &optional logline noerase noerror nowait input)
@ -1395,7 +1402,7 @@ FUNC should leave point at the end of the modified region"
(magit-run* (cons cmd args) nil nil nil t input)) (magit-run* (cons cmd args) nil nil nil t input))
(defun magit-display-process () (defun magit-display-process ()
"Display output from most recent git command" "Display output from most recent git command."
(interactive) (interactive)
(unless (get-buffer magit-process-buffer-name) (unless (get-buffer magit-process-buffer-name)
(error "No Git commands have run")) (error "No Git commands have run"))
@ -1640,7 +1647,7 @@ FUNC should leave point at the end of the modified region"
["Display Git output" magit-display-process t] ["Display Git output" magit-display-process t]
["Quit Magit" quit-window t])) ["Quit Magit" quit-window t]))
(defvar magit-mode-hook nil "Hook run by `magit-mode'") (defvar magit-mode-hook nil "Hook run by `magit-mode'.")
(put 'magit-mode 'mode-class 'special) (put 'magit-mode 'mode-class 'special)
@ -2230,12 +2237,12 @@ must return a string which will represent the log line.")
(propertize message 'face 'magit-log-message))))) (propertize message 'face 'magit-log-message)))))
(defvar magit-log-count () (defvar magit-log-count ()
"internal var used to count the number of log actualy added in a buffer") "Internal var used to count the number of logs actually added in a buffer.")
(defmacro magit-create-log-buffer-sections (&rest body) (defmacro magit-create-log-buffer-sections (&rest body)
"Empty current buffer of text and magit's section, and then evaluate body. "Empty current buffer of text and magit's section, and then evaluate BODY.
if the number of logs inserted in the buffer is magit-log-cutoff-length if the number of logs inserted in the buffer is `magit-log-cutoff-length'
insert a line to tell how to insert more of them" insert a line to tell how to insert more of them"
(declare (indent 0)) (declare (indent 0))
`(let ((magit-log-count 0) (inhibit-read-only t)) `(let ((magit-log-count 0) (inhibit-read-only t))
@ -2256,7 +2263,7 @@ insert a line to tell how to insert more of them"
(msg (match-string 4)) (msg (match-string 4))
(refs (when (match-string 3) (refs (when (match-string 3)
(delq nil (delq nil
(mapcar (mapcar
(lambda (s) (lambda (s)
(and (not (and (not
(or (string= s "tag:") (or (string= s "tag:")
@ -2306,7 +2313,7 @@ insert a line to tell how to insert more of them"
:keymap magit-commit-mode-map) :keymap magit-commit-mode-map)
(defvar magit-commit-buffer-name "*magit-commit*" (defvar magit-commit-buffer-name "*magit-commit*"
"Buffer name for displaying commit log messages") "Buffer name for displaying commit log messages.")
(defun magit-show-commit (commit &optional scroll) (defun magit-show-commit (commit &optional scroll)
(when (magit-section-p commit) (when (magit-section-p commit)
@ -2574,15 +2581,15 @@ With prefix argument, add remaining untracked files as well.
t)) t))
nil)) nil))
(defun magit-checkout (rev) (defun magit-checkout (revision)
"Switch 'HEAD' to REVISION and update working tree. "Switch 'HEAD' to REVISION and update working tree.
Fails if working tree or staging area contain uncommitted changes. Fails if working tree or staging area contain uncommitted changes.
If REVISION is a remote branch, offer to create a local tracking branch. If REVISION is a remote branch, offer to create a local tracking branch.
\('git checkout [-b] REVISION')." \('git checkout [-b] REVISION')."
(interactive (list (magit-read-rev "Switch to" (magit-default-rev)))) (interactive (list (magit-read-rev "Switch to" (magit-default-rev))))
(if rev (if revision
(if (not (magit-maybe-create-local-tracking-branch rev)) (if (not (magit-maybe-create-local-tracking-branch revision))
(magit-run-git "checkout" (magit-rev-to-git rev))))) (magit-run-git "checkout" (magit-rev-to-git revision)))))
(defun magit-read-create-branch-args () (defun magit-read-create-branch-args ()
(let* ((cur-branch (magit-get-current-branch)) (let* ((cur-branch (magit-get-current-branch))
@ -2591,7 +2598,7 @@ If REVISION is a remote branch, offer to create a local tracking branch.
(list branch parent))) (list branch parent)))
(defun magit-create-branch (branch parent) (defun magit-create-branch (branch parent)
"Switch 'HEAD' to new BRANCH at REVISION and update working tree. "Switch 'HEAD' to new BRANCH at revision PARENT and update working tree.
Fails if working tree or staging area contain uncommitted changes. Fails if working tree or staging area contain uncommitted changes.
\('git checkout -b BRANCH REVISION')." \('git checkout -b BRANCH REVISION')."
(interactive (magit-read-create-branch-args)) (interactive (magit-read-create-branch-args))
@ -2609,7 +2616,7 @@ Fails if working tree or staging area contain uncommitted changes.
(magit-section-info (magit-section-parent item))) (magit-section-info (magit-section-parent item)))
((wazzup) info))) ((wazzup) info)))
(defun magit-manual-merge (rev) (defun magit-manual-merge (revision)
"Merge REVISION into the current 'HEAD'; leave changes uncommitted. "Merge REVISION into the current 'HEAD'; leave changes uncommitted.
With a prefix-arg, the merge will be squashed. With a prefix-arg, the merge will be squashed.
\('git merge --no-commit [--squash|--no-ff] REVISION')." \('git merge --no-commit [--squash|--no-ff] REVISION')."
@ -2618,19 +2625,19 @@ With a prefix-arg, the merge will be squashed.
(when current-prefix-arg (when current-prefix-arg
" (squashed)")) " (squashed)"))
(magit-guess-branch)))) (magit-guess-branch))))
(if rev (if revision
(magit-run-git "merge" "--no-commit" (magit-run-git "merge" "--no-commit"
(if current-prefix-arg (if current-prefix-arg
"--squash" "--squash"
"--no-ff") "--no-ff")
(magit-rev-to-git rev)))) (magit-rev-to-git revision))))
(defun magit-automatic-merge (rev) (defun magit-automatic-merge (revision)
"Merge REVISION into the current 'HEAD'; commit unless merge fails. "Merge REVISION into the current 'HEAD'; commit unless merge fails.
\('git merge REVISION')." \('git merge REVISION')."
(interactive (list (magit-read-rev "Merge" (magit-guess-branch)))) (interactive (list (magit-read-rev "Merge" (magit-guess-branch))))
(if rev (if revision
(magit-run-git "merge" (magit-rev-to-git rev)))) (magit-run-git "merge" (magit-rev-to-git revision))))
;;; Rebasing ;;; Rebasing
@ -2770,8 +2777,8 @@ If USE-CACHE is non nil, use the cached information."
;;; Resetting ;;; Resetting
(defun magit-reset-head (rev &optional hard) (defun magit-reset-head (revision &optional hard)
"Switch 'HEAD' to REVISION, keeping prior working tree and staging area "Switch 'HEAD' to REVISION, keeping prior working tree and staging area.
Any differences from REVISION become new changes to be committed. Any differences from REVISION become new changes to be committed.
With prefix argument, all uncommitted changes in working tree With prefix argument, all uncommitted changes in working tree
and staging area are lost. and staging area are lost.
@ -2783,18 +2790,18 @@ and staging area are lost.
(or (magit-default-rev) (or (magit-default-rev)
"HEAD^")) "HEAD^"))
current-prefix-arg)) current-prefix-arg))
(if rev (if revision
(magit-run-git "reset" (if hard "--hard" "--soft") (magit-run-git "reset" (if hard "--hard" "--soft")
(magit-rev-to-git rev)))) (magit-rev-to-git revision))))
(defun magit-reset-head-hard (rev) (defun magit-reset-head-hard (revision)
"Switch 'HEAD' to REVISION, losing all uncommitted changes "Switch 'HEAD' to REVISION, losing all changes.
in both working tree and staging area. Uncomitted changes in both working tree and staging area are lost.
\('git reset --hard REVISION')." \('git reset --hard REVISION')."
(interactive (list (magit-read-rev (format "Hard reset head to") (interactive (list (magit-read-rev (format "Hard reset head to")
(or (magit-default-rev) (or (magit-default-rev)
"HEAD")))) "HEAD"))))
(magit-reset-head rev t)) (magit-reset-head revision t))
(defun magit-reset-working-tree () (defun magit-reset-working-tree ()
"Revert working tree and clear changes from staging area. "Revert working tree and clear changes from staging area.
@ -2916,7 +2923,7 @@ in both working tree and staging area.
(or info (or info
(error "No rewrite in progress")) (error "No rewrite in progress"))
(let* ((pending (cdr (assq 'pending info))) (let* ((pending (cdr (assq 'pending info)))
(first-unused (first-unused
(let ((rpend (reverse pending))) (let ((rpend (reverse pending)))
(while (and rpend (plist-get (cdr (car rpend)) 'used)) (while (and rpend (plist-get (cdr (car rpend)) 'used))
(setq rpend (cdr rpend))) (setq rpend (cdr rpend)))
@ -2982,10 +2989,10 @@ in both working tree and staging area.
;;; Log edit mode ;;; Log edit mode
(defvar magit-log-edit-mode-hook nil "Hook run by `magit-log-edit-mode'") (defvar magit-log-edit-mode-hook nil "Hook run by `magit-log-edit-mode'.")
(defvar magit-log-edit-buffer-name "*magit-edit-log*" (defvar magit-log-edit-buffer-name "*magit-edit-log*"
"Buffer name for composing commit messages") "Buffer name for composing commit messages.")
(defvar magit-log-edit-mode-map (defvar magit-log-edit-mode-map
(let ((map (make-sparse-keymap))) (let ((map (make-sparse-keymap)))
@ -3266,7 +3273,7 @@ Prefix arg means justify as well."
;;; Tags ;;; Tags
(defun magit-tag (name rev) (defun magit-tag (name rev)
"Creates a new lightweight tag with the given NAME at REV. "Create a new lightweight tag with the given NAME at REV.
\('git tag NAME')." \('git tag NAME')."
(interactive (interactive
(list (list
@ -3309,8 +3316,8 @@ Tag will point to the current 'HEAD'."
"stash" "list")) "stash" "list"))
(defun magit-stash (description) (defun magit-stash (description)
"Create new stash of working tree and staging area named DESCRIPTION, "Create new stash of working tree and staging area named DESCRIPTION.
working tree and staging area revert to the current 'HEAD'. Working tree and staging area revert to the current 'HEAD'.
With prefix argument, changes in staging area are kept. With prefix argument, changes in staging area are kept.
\('git stash save [--keep-index] DESCRIPTION')" \('git stash save [--keep-index] DESCRIPTION')"
(interactive "sStash description: ") (interactive "sStash description: ")
@ -3339,7 +3346,7 @@ With prefix argument, changes in staging area are kept.
:keymap magit-stash-mode-map) :keymap magit-stash-mode-map)
(defvar magit-stash-buffer-name "*magit-stash*" (defvar magit-stash-buffer-name "*magit-stash*"
"Buffer name for displaying a stash") "Buffer name for displaying a stash.")
(defun magit-show-stash (stash &optional scroll) (defun magit-show-stash (stash &optional scroll)
(when (magit-section-p stash) (when (magit-section-p stash)
@ -3530,9 +3537,9 @@ With a non numeric prefix ARG, show all entries"
:keymap magit-log-mode-map) :keymap magit-log-mode-map)
(defvar magit-log-buffer-name "*magit-log*" (defvar magit-log-buffer-name "*magit-log*"
"Buffer name for display of log entries") "Buffer name for display of log entries.")
(defvar magit-log-grep-buffer-name "*magit-grep-log*" (defvar magit-log-grep-buffer-name "*magit-grep-log*"
"Buffer name for display of log grep results") "Buffer name for display of log grep results.")
(defun magit-display-log (ask-for-range &rest extra-args) (defun magit-display-log (ask-for-range &rest extra-args)
(let* ((log-range (if ask-for-range (let* ((log-range (if ask-for-range
@ -3673,7 +3680,7 @@ With a non numeric prefix ARG, show all entries"
(branches (if all all-branches (branches (if all all-branches
(delq nil (mapcar (delq nil (mapcar
(lambda (b) (lambda (b)
(and (not (and (not
(member (cdr b) excluded)) (member (cdr b) excluded))
b)) b))
all-branches)))) all-branches))))
@ -3949,7 +3956,7 @@ Return values:
(delete-window)) (delete-window))
(defun magit--branch-name-from-line (line) (defun magit--branch-name-from-line (line)
"Extract the branch name from one line of 'git branch' output." "Extract the branch name from line LINE of 'git branch' output."
(get-text-property 0 'branch-name line)) (get-text-property 0 'branch-name line))
(defun magit--branch-name-at-point () (defun magit--branch-name-at-point ()
@ -4020,7 +4027,7 @@ With prefix force the removal even it it hasn't been merged."
res)))) res))))
(defun magit-show-branches () (defun magit-show-branches ()
"Show all of the current branches in other-window." "Show all of the current branches in `other-window'."
(interactive) (interactive)
(unless (eq major-mode 'magit-show-branches-mode) (unless (eq major-mode 'magit-show-branches-mode)
(let ((topdir (magit-get-top-dir default-directory))) (let ((topdir (magit-get-top-dir default-directory)))
@ -4113,7 +4120,7 @@ With prefix force the removal even it it hasn't been merged."
(magit-interactive-resolve (cadr info))))) (magit-interactive-resolve (cadr info)))))
(defun magit-list-buffers () (defun magit-list-buffers ()
"Returns a list of magit buffers." "Return a list of magit buffers."
(delq nil (mapcar (lambda (b) (delq nil (mapcar (lambda (b)
(with-current-buffer b (with-current-buffer b
(when (eq major-mode 'magit-mode) (when (eq major-mode 'magit-mode)
@ -4130,7 +4137,7 @@ With prefix force the removal even it it hasn't been merged."
(reverse tmp-list))) (reverse tmp-list)))
(defun magit-list-projects () (defun magit-list-projects ()
"Returns a list of directories with a magit representation." "Return a list of directories with a magit representation."
(remove-dupes (remove-dupes
(sort (sort
(mapcar (lambda (b) (mapcar (lambda (b)