Re: [PATCH 6/6] doc/git-commit: add documentation for fixup[amend|reword] options
- From
Charvi Mendiratta <charvi077@gmail.com>
- Date
- Feb 19, 2021, 06:09 UTC
- Message-ID
- <CAPSFM5dEEdXwgtfz==6e_745N93kWNT4tgxRGMBmz4BPynGXKQ@mail.gmail.com>
- In-Reply-To
- <xmqqlfblfae2.fsf@gitster.g>
On Fri, 19 Feb 2021 at 00:53, Junio C Hamano <gitster@pobox.com> wrote: [...]
Show 24 quoted lines
> > + > > + When used with alternative option `reword`, let's say > > + `git commit --fixup=reword:<commit>`, it works similar to `amend` > > + option, but here it creates an empty "amend!" commit, i.e it does > > + not take any staged changes and only allows to fixup the commit > > + message of the specified commit. It will reword the specified > > + commit when it is rebased with `--autosquash`. > > + > > + `--fixup`, with or without option, can be used with additional > > + commit message option `-m` but not with `-F`/`-c`/`-C`. See > > + linkgit:git-rebase[1] for details. > > You must dedent the second and the subsequent paragraphs and replace > each of these blank lines that mark inter-paragraph breaks with a > line with a single plus '+' sign on it. See how "is mutually > exclusive" explanation is appended to the description of "-m" as its > second paragraph. > > Side note. It probably needs "exclusive -> incompatible". > > The description in git-rebase.txt you touched is another good > example. Mimic the way its second paragraph "If the autosquash is > enabled..." is formatted. >
Got it. Thanks for pointing this out, I will correct it.