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

Re: [PATCH v7 1/5] command-list.txt: prepare with [commands] header

From
Eric Sunshine <sunshine@sunshineco.com>
Date
May 15, 2015, 20:52 UTC
Message-ID
<CAPig+cSjHyh5eO6KWYMo_OxUmDQWP9TnnuaBvnBGWVDh7pesOQ@mail.gmail.com>
In-Reply-To
<xmqqmw15fu5m.fsf@gitster.dls.corp.google.com>
On Fri, May 15, 2015 at 4:44 PM, Junio C Hamano <gitster@pobox.com> wrote:
Show 26 quoted lines
> Sébastien Guimmara  <sebastien.guimmara@gmail.com> writes:
>>> You could for example have used the existing "# List of known git
>>> commands" as such a signal to tell that all the no comment lines
>>> below are commands.
>>
>> I tend to think that relying on comments as marks for parsers is brittle,
>> but indeed square brackets get in the way of sed regexes. I'll think of
>> something better. Thanks.
>
> Heh, we, and more importantly our users, already rely on a marker in
> comments when writing their commit log messages ;-)
>
> I would not be opposed to a new header that is outside comment, but
> I do not think the marker line that is also a comment is "brittle"
> and would not be opposed to that, either.
>
>     # do not molest the next line
>     ### command list
>     # name category
>     git-add mainporcelain
>     ...
>
> would be perfectly acceptable.
>
> I was just pointing out that you did not even have to have patch
> 1/5.

Is that entirely accurate? The machinery (Makefiles, cmd-list.perl) does have to be updated at some point to skip the "common" block which get added in patch 2/5. That work could be done as part of patch 2/5, though it seemed cleaner to me to make it separate (though I don't care too strongly).

Previous: Junio C HamanoNext: Junio C Hamano
Message 6 of 23 in “git help: group common commands by theme”
  1. 0/5 git help: group common commands by themeSébastien Guimmara, May 15, 2015
  2. 1/5 command-list.txt: prepare with [commands] headerSébastien Guimmara, May 15, 2015
  3. Junio C HamanoMay 15, 2015
  4. Sébastien GuimmaraMay 15, 2015
  5. Junio C HamanoMay 15, 2015
  6. Eric SunshineMay 15, 2015
  7. Junio C HamanoMay 15, 2015
  8. Eric SunshineMay 15, 2015
  9. Sébastien GuimmaraMay 18, 2015
  10. Eric SunshineMay 15, 2015
  11. Philip OakleyMay 16, 2015
  12. Sébastien GuimmaraMay 16, 2015
  13. 2/5 command-list.txt: add a [common] blockSébastien Guimmara, May 15, 2015
  14. Eric SunshineMay 15, 2015
  15. 3/5 generate-cmdlist: parse common group commandsSébastien Guimmara, May 15, 2015
  16. Eric SunshineMay 15, 2015
  17. 4/5 command-list.txt: drop the common tagSébastien Guimmara, May 15, 2015
  18. Eric SunshineMay 15, 2015
  19. 5/5 help.c: output the typical Git workflowSébastien Guimmara, May 15, 2015
  20. Eric SunshineMay 15, 2015
  21. Eric SunshineMay 15, 2015
  22. Junio C HamanoMay 15, 2015
  23. Sébastien GuimmaraMay 15, 2015

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.