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

Re: [PATCH 0/3] doc: unify config info on some cmds

From
Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Date
Jul 16, 2022, 07:53 UTC
Message-ID
<220716.867d4dze37.gmgdl@evledraar.gmail.com>
In-Reply-To
<CAHd-oW4zHA1YLX-5B1vYTA1f8PocziUCi0WxvSEkFUuf2GqKxg@mail.gmail.com>
On Fri, Jul 15 2022, Matheus Tavares wrote:
Show 37 quoted lines
> Em qui, 14 de jul de 2022 18:27, Ævar Arnfjörð Bjarmason
> <avarab@gmail.com> escreveu:
>>
>>
>> Here's a cleaned up version of what I have, which I figure is probably
>> better linked-to than contributing to my E-Mail quota :):
>>
>>         https://github.com/git/git/compare/master...avar:git:avar/doc-config-includes
>
> Thanks for sharing your version!
>
>> The one thing I'd like you to reconsider is to drop the idea of adding
>> these "ifndef::git-grep[]" defines and the like. In your version it
>> yields an arguably better result.
>>
>> But I think what we should be going for is the more general direction
>> outlined above, at which point that becomes quite a mess of
>> ifdefs. I.e. config/gc/rerere.txt would need to know what it's going to
>> get include in, which would be N number of manpages in the genreal case,
>> not just "main or config" as this series leaves it.
>>
>> I think the solution I have to that in 1/9 in that first series is a
>> better trade-off, i.e. we just (eventually, your series doesn't need to
>> do that) include some standard wording saying that what you're looking
>> at in git-CMD(1) is transcluded as-is from the relevant part of
>> git-config(1). I.e.:
>>
>>         Everything below this line in this section is selectively included
>>         from the linkgit:git-config[1] documentation. The content is the same
>>         as what's found there:
>>
>> What do you think about doing that instead?
>
> I like the includes/* idea, and I agree that it is a more sensible way
> forward than the many 'ifndef[]::git-cmd.txt's :) Your linked changes
> also cover a wider range of cmds than my series does. So I'd be happy
> to have them as a replacement to this series.

I can submit what I've got as a v2 if you'd like, but I'd be just as happy with you picking this up & running with it, whether that's seeing what you'd like to integrate into your series here, or perhaps rebasing your patches on the 1st patch I have (the one that introduces those "Everything below this..." template)>

But OTOH if you're going to drop the "ifndef" idea I think what you'd come up with will be identical to the patch bodies I've got for the bits you modified, so perhaps it's easier if I just submit mine...

Just let me know, I'd just like these docs fixed & unified.
Previous: Matheus TavaresNext: Matheus Tavares
Message 10 of 56 in “doc: unify config info on some cmds”
  1. 0/3 doc: unify config info on some cmdsMatheus Tavares, Jul 14, 2022
  2. 1/3 doc: grep: unify configuration variables definitionsMatheus Tavares, Jul 14, 2022
  3. Junio C HamanoJul 14, 2022
  4. 2/3 doc: apply: unify configuration variables definitionsMatheus Tavares, Jul 14, 2022
  5. Junio C HamanoJul 14, 2022
  6. 3/3 doc: notes: unify configuration variables definitionsMatheus Tavares, Jul 14, 2022
  7. Junio C HamanoJul 14, 2022
  8. Ævar Arnfjörð BjarmasonJul 14, 2022
  9. Matheus TavaresJul 15, 2022
  10. Ævar Arnfjörð BjarmasonJul 16, 2022
  11. Matheus TavaresJul 17, 2022
  12. 0/9 docs: de-duplicate sections, add more CONFIGURATION sectionsÆvar Arnfjörð Bjarmason, Jul 29, 2022
  13. 1/9 docs: add and use include template for config/* includesÆvar Arnfjörð Bjarmason, Jul 29, 2022
  14. Matheus TavaresJul 30, 2022
  15. 2/9 grep docs: de-duplicate configuration sectionsÆvar Arnfjörð Bjarmason, Jul 29, 2022
  16. Matheus TavaresJul 30, 2022
  17. 3/9 send-email docs: de-duplicate configuration sectionsÆvar Arnfjörð Bjarmason, Jul 29, 2022
  18. Matheus TavaresJul 30, 2022
  19. 5/9 notes docs: de-duplicate configuration sectionsÆvar Arnfjörð Bjarmason, Jul 29, 2022
  20. Matheus TavaresJul 30, 2022
  21. 6/9 difftool docs: de-duplicate configuration sectionsÆvar Arnfjörð Bjarmason, Jul 29, 2022
  22. Matheus TavaresJul 30, 2022
  23. 4/9 apply docs: de-duplicate configuration sectionsÆvar Arnfjörð Bjarmason, Jul 29, 2022
  24. Matheus TavaresJul 30, 2022
  25. 7/9 log docs: de-duplicate configuration sectionsÆvar Arnfjörð Bjarmason, Jul 29, 2022
  26. Matheus TavaresJul 30, 2022
  27. 8/9 docs: add CONFIGURATION sections that map to a built-inÆvar Arnfjörð Bjarmason, Jul 29, 2022
  28. Junio C HamanoJul 29, 2022
  29. 9/9 docs: add CONFIGURATION sections that fuzzy map to built-insÆvar Arnfjörð Bjarmason, Jul 29, 2022
  30. Junio C HamanoJul 29, 2022
  31. Matheus TavaresJul 30, 2022
  32. Junio C HamanoJul 30, 2022
  33. Matheus TavaresJul 30, 2022
  34. 0/9 docs: de-duplicate sections, add more CONFIGURATION sectionsÆvar Arnfjörð Bjarmason, Aug 31, 2022
  35. 1/9 docs: add and use include template for config/* includesÆvar Arnfjörð Bjarmason, Aug 31, 2022
  36. 2/9 grep docs: de-duplicate configuration sectionsÆvar Arnfjörð Bjarmason, Aug 31, 2022
  37. 4/9 apply docs: de-duplicate configuration sectionsÆvar Arnfjörð Bjarmason, Aug 31, 2022
  38. 3/9 send-email docs: de-duplicate configuration sectionsÆvar Arnfjörð Bjarmason, Aug 31, 2022
  39. 5/9 notes docs: de-duplicate and combine configuration sectionsÆvar Arnfjörð Bjarmason, Aug 31, 2022
  40. 6/9 difftool docs: de-duplicate configuration sectionsÆvar Arnfjörð Bjarmason, Aug 31, 2022
  41. 7/9 log docs: de-duplicate configuration sectionsÆvar Arnfjörð Bjarmason, Aug 31, 2022
  42. 8/9 docs: add CONFIGURATION sections that map to a built-inÆvar Arnfjörð Bjarmason, Aug 31, 2022
  43. 9/9 docs: add CONFIGURATION sections that fuzzy map to built-insÆvar Arnfjörð Bjarmason, Aug 31, 2022
  44. Matheus TavaresSep 3, 2022
  45. 0/9 docs: de-duplicate sections, add more CONFIGURATION sectionsÆvar Arnfjörð Bjarmason, Sep 7, 2022
  46. 1/9 docs: add and use include template for config/* includesÆvar Arnfjörð Bjarmason, Sep 7, 2022
  47. 2/9 grep docs: de-duplicate configuration sectionsÆvar Arnfjörð Bjarmason, Sep 7, 2022
  48. 3/9 send-email docs: de-duplicate configuration sectionsÆvar Arnfjörð Bjarmason, Sep 7, 2022
  49. 4/9 apply docs: de-duplicate configuration sectionsÆvar Arnfjörð Bjarmason, Sep 7, 2022
  50. 5/9 notes docs: de-duplicate and combine configuration sectionsÆvar Arnfjörð Bjarmason, Sep 7, 2022
  51. 6/9 difftool docs: de-duplicate configuration sectionsÆvar Arnfjörð Bjarmason, Sep 7, 2022
  52. 7/9 log docs: de-duplicate configuration sectionsÆvar Arnfjörð Bjarmason, Sep 7, 2022
  53. 8/9 docs: add CONFIGURATION sections that map to a built-inÆvar Arnfjörð Bjarmason, Sep 7, 2022
  54. 9/9 docs: add CONFIGURATION sections that fuzzy map to built-insÆvar Arnfjörð Bjarmason, Sep 7, 2022
  55. Matheus TavaresSep 7, 2022
  56. Junio C HamanoSep 7, 2022

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.