From: Jakub Narębski Date: Thu, 17 Oct 2013 11:13:29 GMT Subject: Re: [RFC/PATCH] doc: git-foo was obsoleted several years ago Message-ID: <525FC659.8020608@gmail.com> In-Reply-To: W dniu 2013-10-16 23:38, Junio C Hamano pisze: > Felipe Contreras writes: [...] > I recall that I wanted to see this change happen myself long time > ago, and suspect that there may have been some reason that prevented > us from doing so. I might have found that AsciiDoc back then did > not like the input if the headline name "git-checkout(1)" did not > match the filename "git-checkout.txt" and the command in the NAME > section "git-checkout", or links "linkgit:git-checkout[1]" from > other pages couldn't have SP there, or something silly like that. > > Also doesn't our build infrastructure slurp the one-line description > "git-checkout - Checkout a branch ..." from these files and expect a > dash to be there? > > In short, I personally do prefer to see dashless form at the top of > the manpage, if it does not break other things, and there may need > changes necessary to avoid breaking other things may to files other > than these documentation-proper source files. > >> diff --git a/Documentation/git-checkout.txt b/Documentation/git-checkout.txt >> index ca118ac..8d98383 100644 >> --- a/Documentation/git-checkout.txt >> +++ b/Documentation/git-checkout.txt >> @@ -1,9 +1,9 @@ >> -git-checkout(1) >> +git checkout(1) >> =============== I wonder if it wouldn't be better to leave as is, in dashed form, as the manpage file name is git-checkout.1, and this manpage is invoked as "man git-checkout", not "man git checkout" or "man 'git checkout'". >> NAME >> ---- >> -git-checkout - Checkout a branch or paths to the working tree >> +git checkout - Checkout a branch or paths to the working tree >> >> SYNOPSIS >> -------- >> ... But change this, as we use this command as "git checkout", not as "git-checkout". -- Jakub Narębski