git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [RFC/PATCH] doc: git-foo was obsoleted several years ago

From
Jakub Narębski <jnareb@gmail.com>
Date
Oct 17, 2013, 11:13 UTC
Message-ID
<525FC659.8020608@gmail.com>
In-Reply-To
<xmqq7gdc7v70.fsf@gitster.dls.corp.google.com>
W dniu 2013-10-16 23:38, Junio C Hamano pisze:
> Felipe Contreras<felipe.contreras@gmail.com>  writes:
[...]
Show 25 quoted lines
> 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'".

Show 8 quoted lines
>>   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
Previous: Jeff KingNext: Antoine Pelisse
Message 4 of 6 in “doc: git-foo was obsoleted several years ago”
  1. doc: git-foo was obsoleted several years agoFelipe Contreras, Sep 21, 2013
  2. Junio C HamanoOct 16, 2013
  3. Jeff KingOct 17, 2013
  4. Jakub NarębskiOct 17, 2013
  5. Antoine PelisseOct 17, 2013
  6. Junio C HamanoOct 17, 2013

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.