branch: elpa/magit
commit e9de48ba0f4ab628dd6b9e18337d51a436db15fe
Author: Jonas Bernoulli <[email protected]>
Commit: Jonas Bernoulli <[email protected]>
manual: Split up "Status Sections" section
---
docs/magit.org | 65 ++++++++++++++++++++++++++---------------------------
docs/magit.texi | 69 +++++++++++++++++++++++++++++----------------------------
2 files changed, 67 insertions(+), 67 deletions(-)
diff --git a/docs/magit.org b/docs/magit.org
index 71fa19e1292..99487e150b1 100644
--- a/docs/magit.org
+++ b/docs/magit.org
@@ -2179,11 +2179,15 @@ hooks and how to customize them.
- User Option: magit-status-sections-hook ::
- Hook run to insert sections into a status buffer.
+ This hook is run to insert sections into a status buffer.
-The first function on that hook by default is
-~magit-insert-status-headers~; it is described in the next section.
-By default the following functions are also members of that hook:
+ The functions described in this section, and the functions
+ ~magit-insert-status-headers~ and ~magit-insert-untracked-files~,
+ which are described in subsequent sections, are members of this
+ hook.
+
+ Some additional functions that can be added to this hook, but are by
+ default added to another hooks, are listed in [[*References Buffer]].
- Function: magit-insert-merge-log ::
@@ -2217,18 +2221,6 @@ By default the following functions are also members of
that hook:
While bisecting, insert section logging bisect progress.
-- Function: magit-insert-untracked-files ::
-
- Maybe insert a list or tree of untracked files.
-
- The option ~magit-status-show-untracked-files~ (which see), in
- cooperation with the Git variable ~status.showUntrackedFiles~,
- control whether and how that is done.
-
- If the first element of ~magit-buffer-diff-files~ is a directory, then
- limit the list to files below that. The value of that variable can
- be set using ~D -- DIRECTORY RET g~.
-
- Function: magit-insert-unstaged-changes ::
Insert section showing unstaged changes.
@@ -2264,7 +2256,28 @@ By default the following functions are also members of
that hook:
Insert section showing commits that haven't been pushed to the
push-remote yet.
-The following functions can also be added to the above hook:
+*** Status File List Sections
+
+Its possible to limit the diffs in the current buffer to a certain
+directory using ~D = f <DIRECTORY> RET g~. If you do that, then that
+that also affects these functions. The diff filter can be used to
+limit to multiple files. In that case these functions only respect
+the first of the files and only if it is a directory.
+
+- Function: magit-insert-untracked-files ::
+
+ Maybe insert a list or tree of untracked files.
+
+ The option ~magit-status-show-untracked-files~ (which see), in
+ cooperation with the Git variable ~status.showUntrackedFiles~,
+ control whether and how that is done.
+
+ If the first element of ~magit-buffer-diff-files~ is a directory, then
+ limit the list to files below that. The value of that variable can
+ be set using ~D -- DIRECTORY RET g~.
+
+While the above function is a member of ~magit-status-section-hook~,
+the following functions by default are not.
- Function: magit-insert-tracked-files ::
@@ -2273,27 +2286,16 @@ The following functions can also be added to the above
hook:
- Function: magit-insert-ignored-files ::
Insert a tree of ignored files.
- Its possible to limit the logs in the current buffer to a certain
- directory using ~D = f <DIRECTORY> RET g~. If you do that, then that
- that also affects this command.
-
- The log filter can be used to limit to multiple files. In that case
- this function only respects the first of the files and only if it is
- a directory.
- Function: magit-insert-skip-worktree-files ::
Insert a tree of skip-worktree files.
- If the first element of ~magit-buffer-diff-files~ is a
- directory, then limit the list to files below that. The value
- of that variable can be set using ~D -- DIRECTORY RET g~.
- Function: magit-insert-assumed-unchanged-files ::
Insert a tree of files that are assumed to be unchanged.
- If the first element of ~magit-buffer-diff-files~ is a
- directory, then limit the list to files below that. The value
- of that variable can be set using ~D -- DIRECTORY RET g~.
+
+*** Status Log Sections
- Function: magit-insert-unpulled-or-recent-commits ::
@@ -2330,9 +2332,6 @@ The following functions can also be added to the above
hook:
a patch-id not shared with any upstream commit) with "+" and
all others with "-".
-See [[*References Buffer]] for some more section inserters, which could be
-used here.
-
*** Status Header Sections
The contents of status buffers is controlled using the hook
diff --git a/docs/magit.texi b/docs/magit.texi
index 484113ea944..75249101b52 100644
--- a/docs/magit.texi
+++ b/docs/magit.texi
@@ -2560,12 +2560,16 @@ The contents of status buffers is controlled using the
hook
hooks and how to customize them.
@defopt magit-status-sections-hook
-Hook run to insert sections into a status buffer.
-@end defopt
+This hook is run to insert sections into a status buffer.
+
+The functions described in this section, and the functions
+@code{magit-insert-status-headers} and @code{magit-insert-untracked-files},
+which are described in subsequent sections, are members of this
+hook.
-The first function on that hook by default is
-@code{magit-insert-status-headers}; it is described in the next section.
-By default the following functions are also members of that hook:
+Some additional functions that can be added to this hook, but are by
+default added to another hooks, are listed in @ref{References Buffer}.
+@end defopt
@defun magit-insert-merge-log
Insert section for the on-going merge. Display the heads that are
@@ -2599,18 +2603,6 @@ While bisecting, insert section visualizing the bisect
state.
While bisecting, insert section logging bisect progress.
@end defun
-@defun magit-insert-untracked-files
-Maybe insert a list or tree of untracked files.
-
-The option @code{magit-status-show-untracked-files} (which see), in
-cooperation with the Git variable @code{status.showUntrackedFiles},
-control whether and how that is done.
-
-If the first element of @code{magit-buffer-diff-files} is a directory, then
-limit the list to files below that. The value of that variable can
-be set using @code{D -- DIRECTORY RET g}.
-@end defun
-
@defun magit-insert-unstaged-changes
Insert section showing unstaged changes.
@end defun
@@ -2646,7 +2638,29 @@ Insert section showing commits that haven't been pushed
to the
push-remote yet.
@end defun
-The following functions can also be added to the above hook:
+@anchor{Status File List Sections}
+@subsection Status File List Sections
+
+Its possible to limit the diffs in the current buffer to a certain
+directory using @code{D = f <DIRECTORY> RET g}. If you do that, then that
+that also affects these functions. The diff filter can be used to
+limit to multiple files. In that case these functions only respect
+the first of the files and only if it is a directory.
+
+@defun magit-insert-untracked-files
+Maybe insert a list or tree of untracked files.
+
+The option @code{magit-status-show-untracked-files} (which see), in
+cooperation with the Git variable @code{status.showUntrackedFiles},
+control whether and how that is done.
+
+If the first element of @code{magit-buffer-diff-files} is a directory, then
+limit the list to files below that. The value of that variable can
+be set using @code{D -- DIRECTORY RET g}.
+@end defun
+
+While the above function is a member of @code{magit-status-section-hook},
+the following functions by default are not.
@defun magit-insert-tracked-files
Insert a tree of tracked files.
@@ -2654,29 +2668,19 @@ Insert a tree of tracked files.
@defun magit-insert-ignored-files
Insert a tree of ignored files.
-Its possible to limit the logs in the current buffer to a certain
-directory using @code{D = f <DIRECTORY> RET g}. If you do that, then that
-that also affects this command.
-
-The log filter can be used to limit to multiple files. In that case
-this function only respects the first of the files and only if it is
-a directory.
@end defun
@defun magit-insert-skip-worktree-files
Insert a tree of skip-worktree files.
-If the first element of @code{magit-buffer-diff-files} is a
-directory, then limit the list to files below that. The value
-of that variable can be set using @code{D -- DIRECTORY RET g}.
@end defun
@defun magit-insert-assumed-unchanged-files
Insert a tree of files that are assumed to be unchanged.
-If the first element of @code{magit-buffer-diff-files} is a
-directory, then limit the list to files below that. The value
-of that variable can be set using @code{D -- DIRECTORY RET g}.
@end defun
+@anchor{Status Log Sections}
+@subsection Status Log Sections
+
@defun magit-insert-unpulled-or-recent-commits
Insert section showing unpulled or recent commits.
If an upstream is configured for the current branch and it is
@@ -2712,9 +2716,6 @@ a patch-id not shared with any upstream commit) with "+"
and
all others with "-".
@end defun
-See @ref{References Buffer} for some more section inserters, which could be
-used here.
-
@anchor{Status Header Sections}
@subsection Status Header Sections
