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

Re: [PATCH/RFC v3 2/4] git-am.txt: add configuration section in git am documentation

From
Remi Lespinet <remi.lespinet@ensimag.grenoble-inp.fr>
Date
Jun 3, 2015, 17:33 UTC
Message-ID
<840759634.89013.1433352813283.JavaMail.zimbra@ensimag.grenoble-inp.fr>
In-Reply-To
<vpq4mmoep9y.fsf@anie.imag.fr>
Matthieu Moy <Matthieu.Moy@grenoble-inp.fr> writes
Show 15 quoted lines
> Most git-*.txt do not have this CONFIGURATION section.
> 
> In an ideal world, we would have such section automatically generated
> (i.e. the description for each variable would exist in one place, and we
> would make sure that both "man git-config" and "man git-<command>" show
> it). In a really ideal world, it would also be propagated to the code
> and we would have a "git config --describe am.keepcr" or so that would
> return the doc.
> 
> I'm a bit worried to see documentation cut-and-pasted from config.txt to
> git-*.txt for maintainability: if the text on one side is modified,
> we're likely to forget the other and the text will diverge with time.
> 
> Not a strong objection, but I have the feeling that the more we do this
> kind of patches, the harder it will be if ever we decide to do the above.

I've seen occurences of this (mainly git-rebase.txt and git-grep), but I agree, I think I'll remove the configuration section.

Show 21 quoted lines
> > +CONFIGURATION
> > +-------------
> > +
> > +am.keepcr::
> > +        If true, git-am will call git-mailsplit for patches in mbox format
> 
> `git am`
> `git mailsplit`
> 
> > +        with parameter '--keep-cr'. In this case git-mailsplit will
> 
> Likewise
> 
> > +        not remove `\r` from lines ending with `\r\n`. Can be overridden
> > +        by giving '--no-keep-cr' from the command line.
> 
> That should be backquote, not forward-quote, right?
> 
> I know it's not your code since it's a cut-and-paste from config.txt,
> but that illustrates my point above: we used to have one place with
> wrong quotes, and we'd have two after the patch.
Ok I'll correct it in a minor patch
Previous: Junio C HamanoNext: Remi Lespinet
Message 9 of 16 in “git-am.sh: fix initialization of the threeway variable”
  1. 1/4 git-am.sh: fix initialization of the threeway variableRemi Lespinet, Jun 2, 2015
  2. 2/4 git-am.txt: add configuration section in git am documentationRemi Lespinet, Jun 2, 2015
  3. Junio C HamanoJun 2, 2015
  4. Torsten BögershausenJun 3, 2015
  5. 2/4 git-am.txt: add configuration section in git am documentationRemi Lespinet, Jun 3, 2015
  6. Torsten BögershausenJun 4, 2015
  7. Matthieu MoyJun 3, 2015
  8. Junio C HamanoJun 3, 2015
  9. Remi LespinetJun 3, 2015
  10. Remi LespinetJun 4, 2015
  11. 3/4 t4150-am: refactor am -3 testsRemi Lespinet, Jun 2, 2015
  12. 4/4 git-am: add am.threeWay config variableRemi Lespinet, Jun 2, 2015
  13. Junio C HamanoJun 2, 2015
  14. Matthieu MoyJun 3, 2015
  15. 4/4 git-am: add am.threeWay config variableRemi Lespinet, Jun 3, 2015
  16. Junio C HamanoJun 2, 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.