branch: elpa/magit commit a8d7460612cd834bd011e93edc6b0d80a313691f Author: Jonas Bernoulli <jo...@bernoul.li> Commit: Jonas Bernoulli <jo...@bernoul.li>
manual: Categorize "Options used by commit commands" section --- docs/magit.org | 47 ++++++++++++++++++++++++++--------------------- docs/magit.texi | 56 +++++++++++++++++++++++++++++++++++--------------------- 2 files changed, 61 insertions(+), 42 deletions(-) diff --git a/docs/magit.org b/docs/magit.org index 4db6a11c522..4972e68960f 100644 --- a/docs/magit.org +++ b/docs/magit.org @@ -4813,33 +4813,17 @@ appended to those arguments when calling ~git commit~. This command calls ~git commit --squash=COMMIT --no-edit~ and then ~git rebase --autosquash MERGE-BASE~. -**** Options for commit commands - -- User Option: magit-commit-ask-to-stage :: - - Whether to ask to stage all unstaged changes when committing and nothing is - staged. +**** Options used by commit commands +***** Used by all or most commit commands - User Option: magit-commit-show-diff :: Whether the relevant diff is automatically shown when committing. -- User Option: magit-commit-extend-override-date :: - - Whether using ~magit-commit-extend~ changes the committer date. - -- User Option: magit-commit-reword-override-date :: - - Whether using ~magit-commit-reword~ changes the committer date. - -- User Option: magit-commit-squash-confirm :: +- User Option: magit-commit-ask-to-stage :: - Whether the commit targeted by squash and fixup has to be confirmed. - When non-nil then the commit at point (if any) is used as default - choice. Otherwise it has to be confirmed. This option only affects - ~magit-commit-squash~ and ~magit-commit-fixup~. The "instant" variants - always require confirmation because making an error while using - those is harder to recover from. + Whether to ask to stage all unstaged changes when committing and + nothing is staged. - User Option: magit-post-commit-hook :: @@ -4879,6 +4863,27 @@ appended to those arguments when calling ~git commit~. Also see https://github.com/magit/magit/issues/4132. +***** Used by all squash and fixup commands + +- User Option: magit-commit-squash-confirm :: + + Whether the commit targeted by squash and fixup has to be confirmed. + When non-nil then the commit at point (if any) is used as default + choice. Otherwise it has to be confirmed. This option only affects + ~magit-commit-squash~ and ~magit-commit-fixup~. The "instant" variants + always require confirmation because making an error while using + those is harder to recover from. + +***** Used by specific commit commands + +- User Option: magit-commit-extend-override-date :: + + Whether using ~magit-commit-extend~ changes the committer date. + +- User Option: magit-commit-reword-override-date :: + + Whether using ~magit-commit-reword~ changes the committer date. + *** Editing Commit Messages After initiating a commit as described in the previous section, two new diff --git a/docs/magit.texi b/docs/magit.texi index 3c7bdbe4405..ffeeeb3f13e 100644 --- a/docs/magit.texi +++ b/docs/magit.texi @@ -5710,33 +5710,21 @@ This command calls @code{git commit --squash=COMMIT --no-edit} and then @code{git rebase --autosquash MERGE-BASE}. @end table -@anchor{Options for commit commands} -@subsubheading Options for commit commands +@anchor{Options used by commit commands} +@subsubheading Options used by commit commands + +@itemize +@item +@anchor{Used by all or most commit commands}Used by all or most commit commands -@defopt magit-commit-ask-to-stage -Whether to ask to stage all unstaged changes when committing and nothing is -staged. -@end defopt @defopt magit-commit-show-diff Whether the relevant diff is automatically shown when committing. @end defopt -@defopt magit-commit-extend-override-date -Whether using @code{magit-commit-extend} changes the committer date. -@end defopt - -@defopt magit-commit-reword-override-date -Whether using @code{magit-commit-reword} changes the committer date. -@end defopt - -@defopt magit-commit-squash-confirm -Whether the commit targeted by squash and fixup has to be confirmed. -When non-nil then the commit at point (if any) is used as default -choice. Otherwise it has to be confirmed. This option only affects -@code{magit-commit-squash} and @code{magit-commit-fixup}. The "instant" variants -always require confirmation because making an error while using -those is harder to recover from. +@defopt magit-commit-ask-to-stage +Whether to ask to stage all unstaged changes when committing and +nothing is staged. @end defopt @defopt magit-post-commit-hook @@ -5777,6 +5765,32 @@ diff buffer would end up being displayed in a new frame. Also see @uref{https://github.com/magit/magit/issues/4132}. @end defopt +@item +@anchor{Used by all squash and fixup commands}Used by all squash and fixup commands + + +@defopt magit-commit-squash-confirm +Whether the commit targeted by squash and fixup has to be confirmed. +When non-nil then the commit at point (if any) is used as default +choice. Otherwise it has to be confirmed. This option only affects +@code{magit-commit-squash} and @code{magit-commit-fixup}. The "instant" variants +always require confirmation because making an error while using +those is harder to recover from. +@end defopt + +@item +@anchor{Used by specific commit commands}Used by specific commit commands + + +@defopt magit-commit-extend-override-date +Whether using @code{magit-commit-extend} changes the committer date. +@end defopt + +@defopt magit-commit-reword-override-date +Whether using @code{magit-commit-reword} changes the committer date. +@end defopt +@end itemize + @anchor{Editing Commit Messages} @subsection Editing Commit Messages