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

Re: [RFC/PATCH] Formatting variables in the documentation

From
Jeff King <peff@peff.net>
Date
May 26, 2016, 16:39 UTC
Message-ID
<20160526163910.GA18597@sigill.intra.peff.net>
In-Reply-To
<xmqqbn3sydvk.fsf@gitster.mtv.corp.google.com>
On Thu, May 26, 2016 at 09:37:19AM -0700, Junio C Hamano wrote:
Show 13 quoted lines
> >> There was no particular "caveat" raised there to recommend against
> >> using this on particular versions of tools or platforms.  It was
> >> inertia that has kept the new optional feature "optional".
> >
> > Thanks for digging. That matches my recollection and the limited
> > research I did more recently.
> 
> For completeness's sake I should point out that the discussion on
> the first thread did point out some version-dependent issues.  But
> with 79c461d5 (docs: default to more modern toolset, 2010-11-19), we
> declared the problematic versions obsolete; I suspect that it is
> safe to assume that those who would be hurt by flipping the default
> would already be extinct after 6 years since then.

Yeah, I'd agree, though that may be worth mentioning in the commit message.

Show 8 quoted lines
> > OK. I was trying to see if (1) could be low-hanging fruit for any of the
> > newcomers, but at this point it probably makes sense for you to just
> > write the patch.
> 
> Leaving it as low-hanging fruit is actually a good idea.
> 
> I was thinking about flipping it in Meta/dodoc.sh, which would
> update the git-manpages.git repository whose mirrors are found at

Ah, right. I was thinking that the patch would go to "master" first, but there is no reason it could not be flipped independently for your build process.

-Peff
Previous: Junio C HamanoNext: Erwan Mathoniere
Message 9 of 34 in “Formatting variables in the documentation”
  1. Formatting variables in the documentationTom Russello, May 18, 2016
  2. Jeff KingMay 18, 2016
  3. Samuel GROOTMay 23, 2016
  4. Matthieu MoyMay 23, 2016
  5. Jeff KingMay 26, 2016
  6. Junio C HamanoMay 26, 2016
  7. Jeff KingMay 26, 2016
  8. Junio C HamanoMay 26, 2016
  9. Jeff KingMay 26, 2016
  10. Documentation: bold literals in manErwan Mathoniere, May 31, 2016
  11. Documentation more consistentTom Russello, Jun 3, 2016
  12. 1/3 Clearer rule about formatting literalsTom Russello, Jun 3, 2016
  13. 2/3 Change environment variables formatTom Russello, Jun 3, 2016
  14. 3/3 Change configuration variables formatTom Russello, Jun 3, 2016
  15. Junio C HamanoJun 3, 2016
  16. Documentation more consistentTom Russello, Jun 6, 2016
  17. 1/3 doc: clearer rule about formatting literalsTom Russello, Jun 6, 2016
  18. Matthieu MoyJun 6, 2016
  19. Matthieu MoyJun 6, 2016
  20. Tom RusselloJun 6, 2016
  21. 2/3 doc: change environment variables formatTom Russello, Jun 6, 2016
  22. Matthieu MoyJun 6, 2016
  23. Tom RusselloJun 6, 2016
  24. 3/3 doc: change configuration variables formatTom Russello, Jun 6, 2016
  25. Matthieu MoyJun 6, 2016
  26. 0/3 Documentation more consistentTom Russello, Jun 7, 2016
  27. 1/3 doc: clearer rule about formatting literalsTom Russello, Jun 7, 2016
  28. 2/3 doc: change environment variables formatTom Russello, Jun 7, 2016
  29. 3/3 doc: more consistency in environment variables formatTom Russello, Jun 7, 2016
  30. Matthieu MoyJun 8, 2016
  31. Tom RusselloJun 8, 2016
  32. Johannes SixtJun 8, 2016
  33. Matthieu MoyJun 8, 2016
  34. 4/3 doc: change configuration variables formatTom Russello, Jun 8, 2016

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.