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

[PATCH] Documentation: bold literals in man

From
Erwan Mathoniere <erwan.mathoniere@grenoble-inp.org>
Date
May 31, 2016, 16:20 UTC
Message-ID
<20160531162033.7137-1-erwan.mathoniere@grenoble-inp.org>
In-Reply-To
<xmqqbn3sydvk.fsf@gitster.mtv.corp.google.com>

Backticks are emphasized through monospaced styling in the HTML version of Git documentation. But were left unstyled in the man version.

To make the man version reading more comfortable, `MAN_BOLD_LITERAL` was added by: 5121a6d (Documentation: option to render literal text as bold for manpages, 2009-03-27) It allowed the user to build the documentation manpages with literals in bold style.

For precaution it was not set by default. Since 79c461d (docs: default to more modern toolset, 2010-11-19), it is assumed ASCIIDOC 8 and at least docbook-xsl 1.73 are used, so no compatibility issue may occur.

Remove `MAN_BOLD_LITERAL`. Set by default literals as bold. Implement `NO_MAN_BOLD_LITERAL`, a new Makefile option, disabling this feature when defined.

Signed-off-by: Erwan MATHONIERE <erwan.mathoniere@grenoble-inp.org>
Signed-off-by: Samuel GROOT <samuel.groot@grenoble-inp.org>
Signed-off-by: Tom RUSSELLO <tom.russello@grenoble-inp.org>
Signed-off-by: Matthieu MOY <matthieu.moy@grenoble-inp.fr>
---
 Documentation/Makefile | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Documentation/Makefile b/Documentation/Makefile
index f6e288b..35c1385 100644
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -146,7 +146,7 @@ else
 	ASCIIDOC_EXTRA += -a git-asciidoc-no-roff
 	endif
 endif
-ifdef MAN_BOLD_LITERAL
+ifndef NO_MAN_BOLD_LITERAL
 XMLTO_EXTRA += -m manpage-bold-literal.xsl
 endif
 ifdef DOCBOOK_SUPPRESS_SP
-- 
2.8.2.662.gc18eb58
Previous: Jeff KingNext: Tom Russello
Message 10 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.