diff options
| author | Brian Lyles <brianmlyles@gmail.com> | 2024-03-25 18:16:49 -0500 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2024-03-25 16:45:40 -0700 |
| commit | 64a443efe4846d9cf09c7ff50cb9a6660fb49b50 (patch) | |
| tree | 47571a5796509f1d4e8fe99c31004688bc58c815 /Documentation/git-am.txt | |
| parent | 0af38890ade347536af7690ecee9e5e75d1b2b12 (diff) | |
| download | git-64a443efe4846d9cf09c7ff50cb9a6660fb49b50.tar.gz | |
docs: clean up `--empty` formatting in git-rebase(1) and git-am(1)
Both of these pages document very similar `--empty` options, but with
different styles. The exact behavior of these `--empty` options differs
somewhat, but consistent styling in the docs is still beneficial. This
commit aims to make them more consistent.
Break the possible values for `--empty` into separate sections for
readability. Alphabetical order is chosen for consistency.
In a future commit, we'll be documenting a new `--empty` option for
git-cherry-pick(1), making the consistency even more relevant.
Signed-off-by: Brian Lyles <brianmlyles@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-am.txt')
| -rw-r--r-- | Documentation/git-am.txt | 20 |
1 files changed, 13 insertions, 7 deletions
diff --git a/Documentation/git-am.txt b/Documentation/git-am.txt index 463a3c6600..624a6e6fe4 100644 --- a/Documentation/git-am.txt +++ b/Documentation/git-am.txt @@ -66,13 +66,19 @@ OPTIONS --quoted-cr=<action>:: This flag will be passed down to 'git mailinfo' (see linkgit:git-mailinfo[1]). ---empty=(stop|drop|keep):: - By default, or when the option is set to 'stop', the command - errors out on an input e-mail message lacking a patch - and stops in the middle of the current am session. When this - option is set to 'drop', skip such an e-mail message instead. - When this option is set to 'keep', create an empty commit, - recording the contents of the e-mail message as its log. +--empty=(drop|keep|stop):: + How to handle an e-mail message lacking a patch: ++ +-- +`drop`;; + The e-mail message will be skipped. +`keep`;; + An empty commit will be created, with the contents of the e-mail + message as its log. +`stop`;; + The command will fail, stopping in the middle of the current `am` + session. This is the default behavior. +-- -m:: --message-id:: |