Thread (45 messages) 45 messages, 4 authors, 2018-05-04

Re: [PATCH 1/6] doc: fix formatting inconsistency in githooks.txt

From: Martin Ågren <hidden>
Date: 2018-04-10 20:45:00

On 10 April 2018 at 22:04, Andreas Heiduk [off-list ref] wrote:
Am 10.04.2018 um 21:13 schrieb Martin Ågren:
quoted
On 10 April 2018 at 20:32, Andreas Heiduk [off-list ref] wrote:
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?
Your reading seems correct, so I was wrong in my speculation. My guess
is such a patch would be welcome. I checked a couple of man-pages and
this one seems particularly heavy on 'git foo' as opposed to `git foo`.
I think that's a reason to fix it, not to leave it behind.

Martin
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help