Re: [PATCH 1/6] doc: fix formatting inconsistency in githooks.txt
From: Andreas Heiduk <hidden>
Date: 2018-04-10 20:04:49
Am 10.04.2018 um 21:13 schrieb Martin Ågren:
On 10 April 2018 at 20:32, Andreas Heiduk [off-list ref] wrote:quoted
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 <redacted> --- 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. post-rewrite ~~~~~~~~~~~~ -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.
That page mostly uses single quotes and no dash ('git send-email')for
formatting. Reading 'CodingGuidelines' my understanding is, that git
commands should be typeset with backticks, no dash (`git send-email`).
So 'git-rebase' (an similar) *should* be typeset as `git rebase`. But
doing so consistently would be a full-diff for this manual page.
Should I do this?
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. Martin