Commit 810d7fb4 authored by Jonas Bernoulli's avatar Jonas Bernoulli

Link from Custom groups and options to relevant Info nodes

parent 422d776e
......@@ -11,6 +11,9 @@ Changes since v2.9.0
but many options also moved between groups that already existed
before.
* Many Custom groups and options now link to the relevant Info nodes
and to other relevant options.
* Many doc-strings were improved, added, and fixed.
* The obsolete variable `magit-repository-directory-depth' is no
......
......@@ -134,6 +134,7 @@
(defgroup git-commit nil
"Edit Git commit messages."
:prefix "git-commit-"
:link '(info-link "(magit)Editing Commit Messages")
:group 'tools)
;;;###autoload
......
......@@ -83,6 +83,7 @@
(defgroup git-rebase nil
"Edit Git rebase sequences."
:link '(info-link "(magit)Editing Rebase Sequences")
:group 'tools)
(defcustom git-rebase-auto-advance t
......
......@@ -32,6 +32,8 @@
(defgroup magit-auto-revert nil
"Revert buffers when files in repository change."
:link '(custom-group-link auto-revert)
:link '(info-link "(magit)Automatic Reverting of File-Visiting Buffers")
:group 'auto-revert
:group 'magit-essentials
:group 'magit-modes)
......@@ -116,6 +118,7 @@ seconds of user inactivity. That is not desirable."
(define-globalized-minor-mode magit-auto-revert-mode auto-revert-mode
magit-turn-on-auto-revert-mode-if-desired
:package-version '(magit . "2.4.0")
:link '(info-link "(magit)Automatic Reverting of File-Visiting Buffers")
:group 'magit-auto-revert
:group 'magit-essentials
;; When `global-auto-revert-mode' is enabled, then this mode is
......
......@@ -34,6 +34,7 @@
(defgroup magit-blame nil
"Blame support for Magit."
:link '(info-link "(magit)Blaming")
:group 'magit-modes)
(defcustom magit-blame-heading-format "%-20a %C %s"
......
......@@ -41,6 +41,9 @@
(defgroup magit nil
"Controlling Git from Emacs."
:link '(url-link "https://magit.vc")
:link '(info-link "(magit)FAQ")
:link '(info-link "(magit)")
:group 'tools)
(defgroup magit-essentials nil
......@@ -52,6 +55,7 @@ Each of these options falls into one or more of these categories:
* Options that affect safety.
* Options that affect performance.
* Options that are of a personal nature."
:link '(info-link "(magit)Essential Settings")
:group 'magit)
(defgroup magit-miscellaneous nil
......@@ -71,6 +75,8 @@ be certain that Magit supports the arguments that you select.
An option `magit-NAME-argument' specifies the arguments that
are enabled by default by the popup `magit-NAME-popup'."
:link '(info-link "(magit-popup)Customizing Existing Popups")
:link '(info-link "(magit-popup)Usage")
:group 'magit-commands)
(defgroup magit-modes nil
......@@ -79,10 +85,12 @@ are enabled by default by the popup `magit-NAME-popup'."
(defgroup magit-buffers nil
"Options concerning Magit buffers."
:link '(info-link "(magit)Modes and Buffers")
:group 'magit)
(defgroup magit-refresh nil
"Options controlling how Magit buffers are refreshed."
:link '(info-link "(magit)Automatic Refreshing of Magit Buffers")
:group 'magit
:group 'magit-buffers)
......@@ -105,6 +113,10 @@ are enabled by default by the popup `magit-NAME-popup'."
(defgroup magit-related nil
"Options that are relevant to Magit but that are defined elsewhere."
:link '(custom-group-link vc)
:link '(custom-group-link smerge)
:link '(custom-group-link ediff)
:link '(custom-group-link auto-revert)
:group 'magit
:group 'magit-extensions
:group 'magit-essentials)
......@@ -112,6 +124,7 @@ are enabled by default by the popup `magit-NAME-popup'."
(custom-add-to-group 'magit-related 'auto-revert-check-vc-info 'custom-variable)
(custom-add-to-group 'magit-auto-revert 'auto-revert-check-vc-info 'custom-variable)
(custom-add-to-group 'magit-related 'ediff-window-setup-function 'custom-variable)
(custom-add-to-group 'magit-related 'smerge-refine-ignore-whitespace 'custom-variable)
(custom-add-to-group 'magit-related 'vc-follow-symlinks 'custom-variable)
......
......@@ -55,6 +55,7 @@
(defgroup magit-diff nil
"Inspect and manipulate Git diffs."
:link '(info-link "(magit)Diffing")
:group 'magit-modes)
(defcustom magit-diff-mode-hook nil
......@@ -237,6 +238,7 @@ visits the file in the working tree."
(defgroup magit-revision nil
"Inspect and manipulate Git commits."
:link '(info-link "(magit)Revision Buffer")
:group 'magit-modes)
(defcustom magit-revision-mode-hook nil
......
......@@ -37,6 +37,7 @@
(defgroup magit-ediff nil
"Ediff support for Magit."
:link '(info-link "(magit)Ediffing")
:group 'magit-extensions)
(defcustom magit-ediff-quit-hook
......
......@@ -52,6 +52,7 @@
(defgroup magit-log nil
"Inspect and manipulate Git history."
:link '(info-link "(magit)Logging")
:group 'magit-modes)
(defgroup magit-margin nil
......
......@@ -46,6 +46,7 @@ for that variable. Likewise if you set `magit-log-margin's INIT
to nil, then that is used in the default of all other options. But
setting it to t, i.e. re-enforcing the default for that option,
does not carry to other options."
:link '(info-link "(magit)Log Margin")
:group 'magit-log)
(defvar-local magit-buffer-margin nil)
......
......@@ -76,6 +76,7 @@
(defgroup magit-popup nil
"Infix arguments with a popup as feedback."
:link '(info-link "(magit-popup)")
:group 'bindings)
(defgroup magit-popup-faces nil
......
......@@ -41,6 +41,7 @@
(defgroup magit-section nil
"Expandable sections."
:link '(info-link "(magit)Sections")
:group 'magit)
(defcustom magit-section-show-child-count t
......
......@@ -37,6 +37,7 @@
(defgroup magit-wip nil
"Automatically commit to work-in-progress refs."
:link '(info-link "(magit)Wip Modes")
:group 'magit-modes
:group 'magit-essentials)
......
......@@ -75,6 +75,7 @@
(defgroup magit-status nil
"Inspect and manipulate Git repositories."
:link '(info-link "(magit)Status Buffer")
:group 'magit-modes)
(defcustom magit-status-mode-hook nil
......@@ -179,6 +180,7 @@ AUTHOR-WIDTH has to be an integer. When the name of the author
(defgroup magit-refs nil
"Inspect and manipulate Git branches and tags."
:link '(info-link "(magit)References Buffer")
:group 'magit-modes)
(defcustom magit-refs-mode-hook nil
......@@ -469,6 +471,7 @@ specify the depth directly.")
(defgroup magit-repolist nil
"List repositories in a buffer."
:link '(info-link "(magit)Repository List")
:group 'magit-modes)
(defcustom magit-repolist-mode-hook '(hl-line-mode)
......@@ -2869,6 +2872,7 @@ Currently this only adds the following key bindings.
(define-globalized-minor-mode global-magit-file-mode
magit-file-mode magit-file-mode-turn-on
:package-version '(magit . "2.2.0")
:link '(info-link "(magit)Minor Mode for Buffers Visiting Files")
:group 'magit-essentials
:group 'magit-modes)
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment