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

Re: [PATCH v2 0/3] List all guides in git(1)

From
Philippe Blain <levraiphilippeblain@gmail.com>
Date
Aug 4, 2020, 13:44 UTC
Message-ID
<4174B93F-AE21-4F63-A847-06EBF28199DD@gmail.com>
In-Reply-To
<xmqqh7tjtfx6.fsf@gitster.c.googlers.com>
Show 38 quoted lines
> Le 3 août 2020 à 20:26, Junio C Hamano <gitster@pobox.com> a écrit :
> 
> "Philippe Blain via GitGitGadget" <gitgitgadget@gmail.com> writes:
> 
>> Changes since v1:
>> 
>> * Incorporated Junio's suggestion to reduce duplication.
>> 
>> v1: This series adds a list of the guides to git(1).
>> 
>> The first commit adds the misssing guides 'gitcredentials' and
>> 'gitremote-helpers' to command-list.txt. The only missing guide after this
>> change is 'gitweb.conf', but I think this one is obscure anough, and already
>> linked to in 'gitweb.txt', that it does not matter much.
>> 
>> The second commit drops the usage of 'common' and 'useful' for guides. This
>> was suggested as one of two ways forward by Duy in [1] but was not commented
>> on. I'm CC'ing the people that were CC'ed on that message.
>> 
>> The third commit tweaks 'Documentation/cmd-list.perl' so that it also
>> generates a list of the guides, which gets included in 'git.txt'. I chose to
>> put this list just after the end of the list of commands.
>> 
>> [1] 
>> https://lore.kernel.org/git/CACsJy8ADj-bTMYDHxRNLOMppOEdPbVwL49u3XCfNBCmoLLZo+A@mail.gmail.com/
>> 
>> Philippe Blain (3):
>>  command-list.txt: add missing 'gitcredentials' and 'gitremote-helpers'
>>  help: drop usage of 'common' and 'useful' for guides
>>  git.txt: add list of guides
> 
> I think the "dedup the list of cmds-$category.txt" is logically a
> separate step from "we forgot to add guide category so add it", so
> either (1) "add guide twice, and then refactor" or (2) "refactor
> before adding guide, and then add guide only in one place" would be
> more appropriate than (3) "add guide while refactoring".  IMHO, (2)
> would make the most sense.
> 

I agree that (2) makes the most sense, I've split it for v3. (Your "SQUASH???" message on pb/guide-docs may have mislead me :)

Philippe.
Previous: Junio C HamanoNext: Philippe Blain via GitGitGadget
Message 13 of 18 in “[RFC] List all guides in git(1)”
  1. 0/3 [RFC] List all guides in git(1)Philippe Blain via GitGitGadget, Aug 2, 2020
  2. 1/3 command-list.txt: add missing 'gitcredentials' and 'gitremote-helpers'Philippe Blain via GitGitGadget, Aug 2, 2020
  3. 3/3 git.txt: add list of guidesPhilippe Blain via GitGitGadget, Aug 2, 2020
  4. Junio C HamanoAug 2, 2020
  5. Junio C HamanoAug 2, 2020
  6. Philippe BlainAug 3, 2020
  7. 2/3 help: drop usage of 'common' and 'useful' for guidesPhilippe Blain via GitGitGadget, Aug 2, 2020
  8. 0/3 List all guides in git(1)Philippe Blain via GitGitGadget, Aug 4, 2020
  9. 1/3 command-list.txt: add missing 'gitcredentials' and 'gitremote-helpers'Philippe Blain via GitGitGadget, Aug 4, 2020
  10. 2/3 help: drop usage of 'common' and 'useful' for guidesPhilippe Blain via GitGitGadget, Aug 4, 2020
  11. 3/3 git.txt: add list of guidesPhilippe Blain via GitGitGadget, Aug 4, 2020
  12. Junio C HamanoAug 4, 2020
  13. Philippe BlainAug 4, 2020
  14. 0/4 List all guides in git(1)Philippe Blain via GitGitGadget, Aug 5, 2020
  15. 1/4 command-list.txt: add missing 'gitcredentials' and 'gitremote-helpers'Philippe Blain via GitGitGadget, Aug 5, 2020
  16. 2/4 help: drop usage of 'common' and 'useful' for guidesPhilippe Blain via GitGitGadget, Aug 5, 2020
  17. 4/4 git.txt: add list of guidesPhilippe Blain via GitGitGadget, Aug 5, 2020
  18. 3/4 Documentation: don't hardcode command categories twiceJunio C Hamano via GitGitGadget, Aug 5, 2020

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.