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

Re: [PATCH v2 9/9] docs: add CONFIGURATION sections that fuzzy map to built-ins

From
Junio C Hamano <gitster@pobox.com>
Date
Jul 29, 2022, 22:03 UTC
Message-ID
<xmqqlesb4lwh.fsf@gitster.g>
In-Reply-To
<patch-v2-9.9-91689154926-20220729T081959Z-avarab@gmail.com>
Ævar Arnfjörð Bjarmason  <avarab@gmail.com> writes:
Show 7 quoted lines
> Add a CONFIGURATION section to the documentation of various built-ins,
> for those cases where the relevant config/NAME.txt doesn't map only to
> one git-NAME.txt. In particular:
>
>  * config/blame.txt: used by git-{blame,annotate}.txt. Since the
>    git-annotate(1) documentation refers to git-blame(1) don't add a
>    "CONFIGURATION" section to git-annotate(1), only to git-blame(1)>
s/>/./ I think.
>  * config/branch.txt: maps to both git-checkout.txt and
>    git-switch.txt (but nothing else).
s|/branch.txt|/checkout.txt|, I think.
Show 15 quoted lines
>  * config/init.txt: should be included in git-init(1) and
>    git-clone(1).
>
>  * config/column.txt: We should ideally mention the relevant subset of
>    this in git-{branch,clean,status,tag}.txt, but let's punt on it for
>    now. We will when we eventually split these sort of files into
>    e.g. config/column.txt and
>    config/column/{branch,clean,status,tag}.txt, with the former
>    including the latter set.
>
> Things that are being left out, and why:
>
>  * config/remote.txt: let's not include this in
>    git-{fetch,remote,push}.txt etc. for now, various options there
>    change their behavior.

Leaving some stuff out is fine, but I am not sure I understand (note: I didn't say "I agree with") the reasoning. I take "various options there" to mean the configuration variables described in config/remote.txt file? If these variables affect the behaviour of commands like fetch, remote, and push, isn't it more reason to include the description of them?

Previous: Ævar Arnfjörð BjarmasonNext: Matheus Tavares
Message 30 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.