Re: [PATCH 1/6] doc: fix formatting inconsistency in githooks.txt
- Date: Tue, 10 Apr 2018 21:13:30 +0200
- From: Martin Ågren <martin.agren@xxxxxxxxx>
- Subject: Re: [PATCH 1/6] doc: fix formatting inconsistency in githooks.txt
On 10 April 2018 at 20:32, Andreas Heiduk <asheiduk@xxxxxxxxx> wrote:
> The section 'post-rewrite' in 'githooks.txt' renders only one command
> using backticks (`git commit`) but the other commands using single quotes
> ('git-rebase'). Align this formatting to use single quotes.
> Signed-off-by: Andreas Heiduk <asheiduk@xxxxxxxxx>
> Documentation/githooks.txt | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
> diff --git a/Documentation/githooks.txt b/Documentation/githooks.txt
> index f877f7b7cd..070e745b41 100644
> --- a/Documentation/githooks.txt
> +++ b/Documentation/githooks.txt
> @@ -417,8 +417,8 @@ to abort.
> -This hook is invoked by commands that rewrite commits (`git commit
> ---amend`, 'git-rebase'; currently 'git-filter-branch' does 'not' call
> +This hook is invoked by commands that rewrite commits ('git commit
> +--amend', 'git-rebase'; currently 'git-filter-branch' does 'not' call
> it!). Its first argument denotes the command it was invoked by:
> currently one of `amend` or `rebase`. Further command-dependent
> arguments may be passed in the future.
Hmm, I wonder if that is actually intentional. `git commit --amend`
could be run exactly like that and would do what this paragraph expects
of it. The 'git-rebase' is a Git subcommand name, i.e., not some
copy-paste command-line ready for use. If it were something like `git
rebase -i HEAD~5`, I would expect the backticks.
A second discrepancy is the dash in "git commit" vs "git-rebase" and
"git-ls-remote". That could perhaps be explained by the same reasoning.