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

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

From
SGSamuel GROOT <samuel.groot@ensimag.grenoble-inp.fr>
Date
May 23, 2016, 16:00 UTC
Message-ID
<b06231ac-b100-2565-3bf7-99f268014788@ensimag.grenoble-inp.fr>
In-Reply-To
<20160518181500.GD5796@sigill.intra.peff.net>

Some people have suggested to standardize documentation's formatting to make it more consistent.

[1] 2015-04-29 20:13:53 GMT, Junio C Hamano wrote:
> Interesting.  What I happen to use when populating the git-manpages
> repository would have wider impact to the users, as I hear that some
> (or many) distros just package whatever I have there.  I do not mind
> enabling it on my end if that gives us more readable rendition.
[2] On 2015-04-29 20:32:47, Jeff King wrote:
Show 10 quoted lines
> I think it's probably fine and a positive change, but one never knows. I
> guess distros don't package what you ship until you actually tag a
> release, so it would be OK to start doing so during a cycle to shake out
> any problems (and in fact preferable, as anybody who follows "master"
> using "make install-man-quick" would get it early and be able to make a
> report).
>
> If we are doing that, it would make sense to flip MAN_BOLD_LITERAL on by
> default during that same cycle, so we could get reports from people who
> build the manpages from source.
[3] On 2015-11-13 05:45:05, Jeff King wrote:
> If we want to move to backticks, we probably want to also turn on
> MAN_BOLD_LITERAL by default, or it's a step backwards for some folks.
The question is about flipping MAN_BOLD_LITERAL by default or not.

Since 2.8.3 was out recently, we could flip MAN_BOLD_LITERAL on by default for this cycle to shake out problems as Jeff King suggested [2].

Another option could be testing if the system does support bold literal and flipping it on or off accordingly, but I don't know exactly where that could be done.

Previous: Jeff KingNext: Matthieu Moy
Message 3 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.