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

Re: [PATCH 8/8] Docs: config: send-email config options included

From
Michael Witten <mfwitten@mit.edu>
Date
Sep 28, 2008, 19:03 UTC
Message-ID
<C0DC4F74-6157-44AE-A25A-4C74A415CDDA@mit.edu>
In-Reply-To
<20080928032407.GC15696@sigill.intra.peff.net>
On 27 Sep 2008, at 10:24 PM, Jeff King wrote:
Show 8 quoted lines
> On Sat, Sep 27, 2008 at 08:09:56PM -0500, Michael Witten wrote:
>
>> I just copied what is in the send-email man text.
>
> NAK, this makes things much worse by creating two places which must be
> updated with any changes. Shouldn't doing it the right way be as  
> simple
> as something like the patch below?

I also think it is stupid, but I didn't quite understand what you meant before (I must have been skimming).

Also, the surrounding config variable definitions didn't really make it clear that I could (or should) include a file (I didn't even think about it, especially given that I didn't understand your original suggestion).

Show 6 quoted lines
> Though it looks like imap.* simply says "See git-imap-send(1)" in
> config.txt, which would also be OK by me (and makes sense especially  
> if
> we drop most of the sendemail.* description in favor of just  
> mentioning
> the config option near the matching command-line option).

I agree! I think these separate config variable descriptions are superfluous and dangerously subject to obsolescence; consider what config.txt says:

Show 7 quoted lines
> Note that this list is non-comprehensive and not necessarily complete.
> For command-specific variables, you will find a more detailed  
> description
> in the appropriate manual page. You will find a description of non- 
> core
> porcelain configuration variables in the respective porcelain  
> documentation.

I think config.txt is not the place to put this stuff (though I've only given it a quick glance), and include:: will just cause us to litter the place with tool-config.txt include files, which looks yucky and is subject to neglect.

Previous: Jeff KingNext: Jeff King
Message 10 of 45 in “Docs: send-email's usage text and man page mention same options”
  1. 1/8 Docs: send-email's usage text and man page mention same optionsMichael Witten, Sep 28, 2008
  2. 2/8 Docs: send-email usage text much sexierMichael Witten, Sep 28, 2008
  3. 3/8 Docs: send-email: Man page option orderingMichael Witten, Sep 28, 2008
  4. 4/8 send-email: change --no-validate to boolean --[no-]validateMichael Witten, Sep 28, 2008
  5. 5/8 Docs: send-email: --chain_reply_to -> --[no-]chain-reply-toMichael Witten, Sep 28, 2008
  6. 6/8 Docs: Arranged config options in man pageMichael Witten, Sep 28, 2008
  7. 7/8 Docs: send-email: Added all config variables to man endMichael Witten, Sep 28, 2008
  8. 8/8 Docs: config: send-email config options includedMichael Witten, Sep 28, 2008
  9. Jeff KingSep 28, 2008
  10. Michael WittenSep 28, 2008
  11. Jeff KingSep 28, 2008
  12. Jeff KingSep 28, 2008
  13. Michael WittenSep 28, 2008
  14. Jeff KingSep 28, 2008
  15. Jeff KingSep 28, 2008
  16. Michael WittenSep 28, 2008
  17. bash completion: Add --[no-]-validate to "git send-email"Teemu Likonen, Sep 28, 2008
  18. Teemu LikonenSep 28, 2008
  19. Jakub NarebskiSep 28, 2008
  20. Michael WittenSep 28, 2008
  21. Jakub NarebskiSep 29, 2008
  22. Jeff KingSep 29, 2008
  23. 6/9 Docs: send-email: Remove unnecessary config variable descriptionMichael Witten, Sep 29, 2008
  24. 7/9 send-email: Completely replace --signed-off-cc with --signed-off-by-ccMichael Witten, Sep 29, 2008
  25. 8/9 Docs: send-email: Create logical groupings for --help textMichael Witten, Sep 29, 2008
  26. 9/9 Docs: send-email: Create logical groupings for man textMichael Witten, Sep 29, 2008
  27. Jeff KingSep 29, 2008
  28. Miklos VajnaSep 28, 2008
  29. Michael WittenSep 28, 2008
  30. Jeff KingSep 29, 2008
  31. 8/9 Docs: send-email: Create logical groupings for man textMichael Witten, Sep 29, 2008
  32. 9/9 send-email: signedoffcc -> signedoffbycc, but handle bothMichael Witten, Sep 29, 2008
  33. Jeff KingSep 29, 2008
  34. 1/9 Docs: send-email's usage text and man page mention same optionsMichael Witten, Sep 30, 2008
  35. 2/9 Docs: send-email usage text much sexierMichael Witten, Sep 30, 2008
  36. 3/9 Docs: send-email: Man page option orderingMichael Witten, Sep 30, 2008
  37. 4/9 send-email: change --no-validate to boolean --[no-]validateMichael Witten, Sep 30, 2008
  38. 5/9 Docs: send-email: --chain_reply_to -> --[no-]chain-reply-toMichael Witten, Sep 30, 2008
  39. 6/9 Docs: send-email: Remove unnecessary config variable descriptionMichael Witten, Sep 30, 2008
  40. 7/9 Docs: send-email: Create logical groupings for --help textMichael Witten, Sep 30, 2008
  41. 8/9 Docs: send-email: Create logical groupings for man textMichael Witten, Sep 30, 2008
  42. 9/9 send-email: signedoffcc -> signedoffbycc, but handle bothMichael Witten, Sep 30, 2008
  43. Jeff KingOct 1, 2008
  44. Michael WittenOct 1, 2008
  45. Shawn O. PearceOct 1, 2008

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.