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

Better documentation and error reporting.

Browse source 
Corrected style error in comment, docstring, and error message, thanks to
checkdoc-minor-mode and Aspell.

Some indent and minor code style fix too
This commit is contained in:
Rémi Vanicat 2010-03-27 12:20:07 +01:00 committed by Phil Jackson
parent 27ef54451b
commit 07c3225ed6
1 changed files with 83 additions and 79 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

126
magit.el
View file

@ -20,7 +20,7 @@
;; You should have received a copy of the GNU General Public License ;; You should have received a copy of the GNU General Public License
;; along with Magit. If not, see <http://www.gnu.org/licenses/>. ;; along with Magit. If not, see <http://www.gnu.org/licenses/>.
;;; Commentary ;;; Commentary:
;; Invoking the magit-status function will show a buffer with the ;; Invoking the magit-status function will show a buffer with the
;; status of the current git repository and its working tree. That ;; status of the current git repository and its working tree. That
@ -61,6 +61,7 @@
(require 'easymenu) (require 'easymenu)
(require 'diff-mode) (require 'diff-mode)
;;; Code:
(defgroup magit nil (defgroup magit nil
"Controlling Git from Emacs." "Controlling Git from Emacs."
:prefix "magit-" :prefix "magit-"
@ -78,12 +79,12 @@
(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 offers 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 repositors below the directories in magit-repo-dirs, Magit will only descend this many levels deep." "When looking for 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)
@ -106,12 +107,12 @@ Setting this to nil will make it do nothing, setting it to t will arrange things
(const :tag "Ask to stage everything" ask-stage))) (const :tag "Ask to stage everything" ask-stage)))
(defcustom magit-commit-signoff nil (defcustom magit-commit-signoff nil
"When performing git commit adds --signoff" "When performing git commit adds --signoff."
:group 'magit :group 'magit
:type 'boolean) :type 'boolean)
(defcustom magit-log-cutoff-length 100 (defcustom magit-log-cutoff-length 100
"The maximum number of commits to show in the log and whazzup buffers" "The maximum number of commits to show in the log and whazzup buffers."
:group 'magit :group 'magit
:type 'integer) :type 'integer)
@ -123,7 +124,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-log-edit-confirm-cancellation nil (defcustom magit-log-edit-confirm-cancellation nil
"Require acknowledgement before cancelling the log edit buffer." "Require acknowledgment before canceling the log edit buffer."
:group 'magit :group 'magit
:type 'boolean) :type 'boolean)
@ -248,8 +249,7 @@ Many Magit faces inherit from this one by default."
"Function to be called when requesting input from the user.") "Function to be called when requesting input from the user.")
(defvar magit-omit-untracked-dir-contents nil (defvar magit-omit-untracked-dir-contents nil
"When non-nil magit will only list an untracked directory, not "When non-nil magit will only list an untracked directory, not its contents.")
its contents.")
(defface magit-log-head-label-local (defface magit-log-head-label-local
'((((class color) (background light)) '((((class color) (background light))
@ -277,7 +277,7 @@ Many Magit faces inherit from this one by default."
(and transient-mark-mode mark-active))) (and transient-mark-mode mark-active)))
(defun magit-goto-line (line) (defun magit-goto-line (line)
;; Like goto-line but doesn't set the mark. "Like `goto-line' but doesn't set the mark."
(save-restriction (save-restriction
(widen) (widen)
(goto-char 1) (goto-char 1)
@ -481,7 +481,7 @@ Many Magit faces inherit from this one by default."
(defun magit-choose-parent-id (commit op) (defun magit-choose-parent-id (commit op)
(let* ((parents (magit-commit-parents commit))) (let* ((parents (magit-commit-parents commit)))
(if (> (length parents) 1) (if (> (length parents) 1)
(error "Can't %s merge commits." op) (error "Can't %s merge commits" op)
nil))) nil)))
;;; Revisions and ranges ;;; Revisions and ranges
@ -596,8 +596,7 @@ Many Magit faces inherit from this one by default."
(magit-find-section (magit-section-path s) (magit-find-section (magit-section-path s)
magit-old-top-section)))) magit-old-top-section))))
(if magit-top-section (if magit-top-section
(setf (magit-section-children magit-top-section) (push s (magit-section-children magit-top-section))
(cons s (magit-section-children magit-top-section)))
(setq magit-top-section s)) (setq magit-top-section s))
(if old (if old
(setf (magit-section-hidden s) (magit-section-hidden old))) (setf (magit-section-hidden s) (magit-section-hidden old)))
@ -859,13 +858,14 @@ Many Magit faces inherit from this one by default."
(defun magit-section-hideshow (flag-or-func) (defun magit-section-hideshow (flag-or-func)
(let ((section (magit-current-section))) (let ((section (magit-current-section)))
(cond ((magit-section-parent section) (when (magit-section-parent section)
(goto-char (magit-section-beginning section)) (goto-char (magit-section-beginning section))
(if (functionp flag-or-func) (if (functionp flag-or-func)
(funcall flag-or-func section) (funcall flag-or-func section)
(magit-section-set-hidden section flag-or-func)))))) (magit-section-set-hidden section flag-or-func)))))
(defun magit-show-section () (defun magit-show-section ()
"Show current section."
(interactive) (interactive)
(magit-section-hideshow nil)) (magit-section-hideshow nil))
@ -1028,9 +1028,9 @@ Many Magit faces inherit from this one by default."
clauses) clauses)
,@(if opname ,@(if opname
`(((not ,type) `(((not ,type)
(error "Nothing to %s here." ,opname)) (error "Nothing to %s here" ,opname))
(t (t
(error "Can't %s a %s." (error "Can't %s a %s"
,opname ,opname
(or (get ,type 'magit-description) (or (get ,type 'magit-description)
,type))))))))) ,type)))))))))
@ -1069,7 +1069,7 @@ Many Magit faces inherit from this one by default."
&optional logline noerase noerror nowait input) &optional logline noerase noerror nowait input)
(if (and magit-process (if (and magit-process
(get-buffer "*magit-process*")) (get-buffer "*magit-process*"))
(error "Git is already running.")) (error "Git is already running"))
(let ((cmd (car cmd-and-args)) (let ((cmd (car cmd-and-args))
(args (cdr cmd-and-args)) (args (cdr cmd-and-args))
(dir default-directory) (dir default-directory)
@ -1143,7 +1143,7 @@ Many Magit faces inherit from this one by default."
(magit-need-refresh magit-process-client-buffer)))) (magit-need-refresh magit-process-client-buffer))))
(or successp (or successp
noerror noerror
(error "Git failed.")) (error "Git failed"))
successp))) successp)))
(defun magit-process-sentinel (process event) (defun magit-process-sentinel (process event)
@ -1408,15 +1408,16 @@ Many Magit faces inherit from this one by default."
pos) pos)
(defun magit-correct-point-after-command () (defun magit-correct-point-after-command ()
;; Emacs often leaves point in invisible regions, it seems. To fix "Move point outside of invisible regions.
;; this, we move point ourselves and never let Emacs do its own
;; adjustements. Emacs often leaves point in invisible regions, it seems. To fix
;; this, we move point ourselves and never let Emacs do its own
;; When point has to be moved out of an invisible region, it can be adjustments.
;; moved to its end or its beginning. We usually move it to its
;; end, except when that would move point back to where it was When point has to be moved out of an invisible region, it can be
;; before the last command. moved to its end or its beginning. We usually move it to its
;; end, except when that would move point back to where it was
before the last command."
(if (invisible-p (point)) (if (invisible-p (point))
(let ((end (magit-invisible-region-end (point)))) (let ((end (magit-invisible-region-end (point))))
(goto-char (if (= end last-point) (goto-char (if (= end last-point)
@ -1792,7 +1793,7 @@ Please see the manual for a complete description of Magit.
(defun magit-hunk-item-diff (hunk) (defun magit-hunk-item-diff (hunk)
(let ((diff (magit-section-parent hunk))) (let ((diff (magit-section-parent hunk)))
(or (eq (magit-section-type diff) 'diff) (or (eq (magit-section-type diff) 'diff)
(error "Huh? Parent of hunk not a diff.")) (error "Huh? Parent of hunk not a diff"))
diff)) diff))
(defun magit-diff-item-insert-header (diff buf) (defun magit-diff-item-insert-header (diff buf)
@ -1849,10 +1850,10 @@ Please see the manual for a complete description of Magit.
(beginning-of-line) (beginning-of-line)
(let ((line (line-number-at-pos))) (let ((line (line-number-at-pos)))
(if (looking-at "-") (if (looking-at "-")
(error "Can't visit removed lines.")) (error "Can't visit removed lines"))
(goto-char (magit-section-beginning hunk)) (goto-char (magit-section-beginning hunk))
(if (not (looking-at "@@+ .* \\+\\([0-9]+\\),[0-9]+ @@+")) (if (not (looking-at "@@+ .* \\+\\([0-9]+\\),[0-9]+ @@+"))
(error "Hunk header not found.")) (error "Hunk header not found"))
(let ((target (parse-integer (match-string 1)))) (let ((target (parse-integer (match-string 1))))
(forward-line) (forward-line)
(while (< (line-number-at-pos) line) (while (< (line-number-at-pos) line)
@ -1918,13 +1919,13 @@ Please see the manual for a complete description of Magit.
"\\(?:\\((.+?)\\) \\)?" ; refs (3) "\\(?:\\((.+?)\\) \\)?" ; refs (3)
"\\(.*\\)" ; msg (4) "\\(.*\\)" ; msg (4)
"\\)?$") "\\)?$")
"Regexp used to extract elements of git log output with "Regexp used to extract elements of git log output.
--pretty=oneline with graph, or --pretty=format:* %H %s") Those output are generated by --pretty=oneline with graph, or --pretty=format:* %H %s")
(defvar magit-present-log-line-function 'magit-present-log-line (defvar magit-present-log-line-function 'magit-present-log-line
"The function to use when generating a log line. It takes four "The function to use when generating a log line.
args: CHART, SHA1, REFS and MESSAGE. The function must return a It takes four args: CHART, SHA1, REFS and MESSAGE. The function
string which will represent the log line.") must return a string which will represent the log line.")
(defun magit-present-log-line (graph sha1 refs message) (defun magit-present-log-line (graph sha1 refs message)
"The default log line generator." "The default log line generator."
@ -2141,7 +2142,7 @@ string which will represent the log line.")
(magit-insert-unpushed-svn-commits t)))))) (magit-insert-unpushed-svn-commits t))))))
(defun magit-init (dir) (defun magit-init (dir)
"Initialize git repository in specified directory" "Initialize git repository in the DIR directory."
(interactive (list (read-directory-name "Directory for Git repository: "))) (interactive (list (read-directory-name "Directory for Git repository: ")))
(let ((topdir (magit-get-top-dir dir))) (let ((topdir (magit-get-top-dir dir)))
(when (or (not topdir) (when (or (not topdir)
@ -2214,7 +2215,7 @@ string which will represent the log line.")
(magit-apply-hunk-item-reverse item "--cached")) (magit-apply-hunk-item-reverse item "--cached"))
((staged diff) ((staged diff)
(if (eq (car info) 'unmerged) (if (eq (car info) 'unmerged)
(error "Can't unstage a unmerged file. Resolve it first.")) (error "Can't unstage a unmerged file. Resolve it first"))
(magit-run-git "reset" "-q" "HEAD" "--" (magit-diff-item-file item))) (magit-run-git "reset" "-q" "HEAD" "--" (magit-diff-item-file item)))
((unstaged *) ((unstaged *)
(error "Already unstaged")) (error "Already unstaged"))
@ -2274,8 +2275,8 @@ string which will represent the log line.")
(magit-section-info sec)))) (magit-section-info sec))))
(defun magit-manual-merge (rev) (defun magit-manual-merge (rev)
"Merge (without commiting) REV. Given a prefix-arg then the "Merge (without committing) REV.
merge will be squashed." Given a prefix-arg then the merge will be squashed."
(interactive (interactive
(list (magit-read-rev (concat "Manually merge" (list (magit-read-rev (concat "Manually merge"
(when current-prefix-arg (when current-prefix-arg
@ -2383,15 +2384,16 @@ merge will be squashed."
result)) result))
(defvar magit-get-svn-ref-info-cache nil (defvar magit-get-svn-ref-info-cache nil
"As `magit-get-svn-ref-info' might be considered a quite "A cache for svn-ref-info.
expensive operation a cache is taken so that `magit-status' As `magit-get-svn-ref-info' might be considered a quite
doesn't repeatedly call it.") expensive operation a cache is taken so that `magit-status'
doesn't repeatedly call it.")
(defun magit-get-svn-ref-info (&optional use-cache) (defun magit-get-svn-ref-info (&optional use-cache)
"Gather details about the current git-svn repository (nil if "Gather details about the current git-svn repository.
there isn't one). Keys of the alist are ref-path, trunk-ref-name Return nil if there isn't one. Keys of the alist are ref-path,
and local-ref-name. If USE-CACHE is non-nil then return the value trunk-ref-name and local-ref-name.
of `magit-get-svn-ref-info-cache'." If USE-CACHE is non-nil then return the value of `magit-get-svn-ref-info-cache'."
(if use-cache (if use-cache
magit-get-svn-ref-info-cache magit-get-svn-ref-info-cache
(let* ((fetch (magit-get "svn-remote" "svn" "fetch")) (let* ((fetch (magit-get "svn-remote" "svn" "fetch"))
@ -2423,8 +2425,8 @@ of `magit-get-svn-ref-info-cache'."
(cons 'url url)))))))) (cons 'url url))))))))
(defun magit-get-svn-ref (&optional use-cache) (defun magit-get-svn-ref (&optional use-cache)
"Get the best guess remote ref for the current git-svn based "Get the best guess remote ref for the current git-svn based branch.
branch." If USE-CACHE is non nil, use the cached information."
(let ((info (magit-get-svn-ref-info use-cache))) (let ((info (magit-get-svn-ref-info use-cache)))
(cdr (assoc 'local-ref info)))) (cdr (assoc 'local-ref info))))
@ -2523,12 +2525,12 @@ branch."
(defun magit-rewrite-start (from &optional onto) (defun magit-rewrite-start (from &optional onto)
(interactive (list (magit-read-rev "Rewrite from" (magit-default-rev)))) (interactive (list (magit-read-rev "Rewrite from" (magit-default-rev))))
(or (magit-everything-clean-p) (or (magit-everything-clean-p)
(error "You have uncommitted changes.")) (error "You have uncommitted changes"))
(or (not (magit-read-rewrite-info)) (or (not (magit-read-rewrite-info))
(error "Rewrite in progress.")) (error "Rewrite in progress"))
(let* ((orig (magit-git-string "rev-parse" "HEAD")) (let* ((orig (magit-git-string "rev-parse" "HEAD"))
(base (or (car (magit-commit-parents from)) (base (or (car (magit-commit-parents from))
(error "Can't rewrite a commit without a parent, sorry."))) (error "Can't rewrite a commit without a parent, sorry")))
(pending (magit-git-lines "rev-list" (concat base "..")))) (pending (magit-git-lines "rev-list" (concat base ".."))))
(magit-write-rewrite-info `((orig ,orig) (magit-write-rewrite-info `((orig ,orig)
(pending ,@(mapcar #'list pending)))) (pending ,@(mapcar #'list pending))))
@ -2538,7 +2540,7 @@ branch."
(interactive) (interactive)
(let* ((info (magit-read-rewrite-info))) (let* ((info (magit-read-rewrite-info)))
(or info (or info
(error "No rewrite in progress.")) (error "No rewrite in progress"))
(when (or noconfirm (when (or noconfirm
(yes-or-no-p "Stop rewrite? ")) (yes-or-no-p "Stop rewrite? "))
(magit-write-rewrite-info nil) (magit-write-rewrite-info nil)
@ -2549,9 +2551,9 @@ branch."
(let* ((info (magit-read-rewrite-info)) (let* ((info (magit-read-rewrite-info))
(orig (cadr (assq 'orig info)))) (orig (cadr (assq 'orig info))))
(or info (or info
(error "No rewrite in progress.")) (error "No rewrite in progress"))
(or (magit-everything-clean-p) (or (magit-everything-clean-p)
(error "You have uncommitted changes.")) (error "You have uncommitted changes"))
(when (yes-or-no-p "Abort rewrite? ") (when (yes-or-no-p "Abort rewrite? ")
(magit-write-rewrite-info nil) (magit-write-rewrite-info nil)
(magit-run-git "reset" "--hard" orig)))) (magit-run-git "reset" "--hard" orig))))
@ -2564,7 +2566,7 @@ branch."
(defun magit-rewrite-finish-step (first-p) (defun magit-rewrite-finish-step (first-p)
(let ((info (magit-read-rewrite-info))) (let ((info (magit-read-rewrite-info)))
(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 (find-if (lambda (p) (first-unused (find-if (lambda (p)
(not (plist-get (cdr p) 'used))) (not (plist-get (cdr p) 'used)))
@ -2614,7 +2616,7 @@ branch."
(defun magit-push () (defun magit-push ()
(interactive) (interactive)
(let* ((branch (or (magit-get-current-branch) (let* ((branch (or (magit-get-current-branch)
(error "Don't push a detached head. That's gross."))) (error "Don't push a detached head. That's gross")))
(branch-remote (magit-get "branch" branch "remote")) (branch-remote (magit-get "branch" branch "remote"))
(push-remote (if (or current-prefix-arg (push-remote (if (or current-prefix-arg
(not branch-remote)) (not branch-remote))
@ -2724,7 +2726,7 @@ Prefix arg means justify as well."
(cond (author (cond (author
;; XXX - this is a bit strict, probably. ;; XXX - this is a bit strict, probably.
(or (string-match "\\(.*\\) <\\(.*\\)>, \\(.*\\)" author) (or (string-match "\\(.*\\) <\\(.*\\)>, \\(.*\\)" author)
(error "Can't parse author string.")) (error "Can't parse author string"))
;; Shucks, setenv destroys the match data. ;; Shucks, setenv destroys the match data.
(let ((name (match-string 1 author)) (let ((name (match-string 1 author))
(email (match-string 2 author)) (email (match-string 2 author))
@ -3013,7 +3015,7 @@ Prefix arg means justify as well."
(if nil-ok-p (if nil-ok-p
commit commit
(or commit (or commit
(error "No commit at point."))))) (error "No commit at point")))))
(defun magit-apply-commit (commit &optional docommit noerase revert) (defun magit-apply-commit (commit &optional docommit noerase revert)
(let* ((parent-id (magit-choose-parent-id commit "cherry-pick")) (let* ((parent-id (magit-choose-parent-id commit "cherry-pick"))
@ -3207,7 +3209,7 @@ Prefix arg means justify as well."
(let ((ignored (magit-file-lines ignore-file))) (let ((ignored (magit-file-lines ignore-file)))
(cond ((member branch ignored) (cond ((member branch ignored)
(when (or (not edit) (when (or (not edit)
(y-or-n-p "Branch %s is already ignored. Unignore?")) (y-or-n-p "Branch %s is already ignored. Unignore? "))
(setq ignored (delete branch ignored)))) (setq ignored (delete branch ignored))))
(t (t
(setq ignored (append ignored (list branch))))) (setq ignored (append ignored (list branch)))))
@ -3328,13 +3330,13 @@ Prefix arg means justify as well."
"Discard changes in region? " "Discard changes in region? "
"Discard hunk? ")) "Discard hunk? "))
(magit-apply-hunk-item-reverse item "--index")) (magit-apply-hunk-item-reverse item "--index"))
(error "Can't discard this hunk. Please unstage it first."))) (error "Can't discard this hunk. Please unstage it first")))
((unstaged diff) ((unstaged diff)
(magit-discard-diff item nil)) (magit-discard-diff item nil))
((staged diff) ((staged diff)
(if (magit-file-uptodate-p (magit-diff-item-file item)) (if (magit-file-uptodate-p (magit-diff-item-file item))
(magit-discard-diff item t) (magit-discard-diff item t)
(error "Can't discard staged changes to this file. Please unstage it first."))) (error "Can't discard staged changes to this file. Please unstage it first")))
((hunk) ((hunk)
(error "Can't discard this hunk")) (error "Can't discard this hunk"))
((diff) ((diff)
@ -3495,3 +3497,5 @@ Prefix arg means justify as well."
(magit-interactive-resolve (cadr info))))) (magit-interactive-resolve (cadr info)))))
(provide 'magit) (provide 'magit)
;;; magit.el ends here