From: Erwan Mathoniere <erwan.mathoniere@grenoble-inp.org>
To: git@vger.kernel.org
Cc: jordan.de-gea@grenoble-inp.org, gitster@pobox.com, peff@peff.net,
jrnieder@gmail.com, stefan@sevenbyte.org, rybak.a.v@gmail.com,
Erwan Mathoniere <erwan.mathoniere@grenoble-inp.org>,
Samuel GROOT <samuel.groot@grenoble-inp.org>,
Tom RUSSELLO <tom.russello@grenoble-inp.org>,
Matthieu MOY <matthieu.moy@grenoble-inp.fr>
Subject: [PATCH] Documentation: bold literals in man
Date: Tue, 31 May 2016 18:20:33 +0200 [thread overview]
Message-ID: <20160531162033.7137-1-erwan.mathoniere@grenoble-inp.org> (raw)
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
next prev parent reply other threads:[~2016-05-31 16:21 UTC|newest]
Thread overview: 34+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-05-18 15:58 [RFC/PATCH] Formatting variables in the documentation Tom Russello
2016-05-18 18:15 ` Jeff King
2016-05-23 16:00 ` Samuel GROOT
2016-05-23 17:57 ` Matthieu Moy
2016-05-26 4:36 ` Jeff King
2016-05-26 16:18 ` Junio C Hamano
2016-05-26 16:23 ` Jeff King
2016-05-26 16:37 ` Junio C Hamano
2016-05-26 16:39 ` Jeff King
2016-05-31 16:20 ` Erwan Mathoniere [this message]
2016-06-03 22:08 ` [PATCH v2] Documentation more consistent Tom Russello
2016-06-03 22:08 ` [PATCH v2 1/3] Clearer rule about formatting literals Tom Russello
2016-06-03 22:08 ` [PATCH v2 2/3] Change environment variables format Tom Russello
2016-06-03 22:08 ` [PATCH v2 3/3] Change configuration " Tom Russello
2016-06-03 22:42 ` [PATCH v2] Documentation more consistent Junio C Hamano
2016-06-06 10:09 ` [PATCH v3] " Tom Russello
2016-06-06 10:09 ` [PATCH v3 1/3] doc: clearer rule about formatting literals Tom Russello
2016-06-06 13:36 ` Matthieu Moy
2016-06-06 13:42 ` Matthieu Moy
2016-06-06 15:38 ` Tom Russello
2016-06-06 10:09 ` [PATCH v3 2/3] doc: change environment variables format Tom Russello
2016-06-06 14:08 ` Matthieu Moy
2016-06-06 16:34 ` Tom Russello
2016-06-06 10:09 ` [PATCH v3 3/3] doc: change configuration " Tom Russello
2016-06-06 14:09 ` Matthieu Moy
2016-06-07 22:35 ` [PATCH v4 0/3] Documentation more consistent Tom Russello
2016-06-07 22:35 ` [PATCH v4 1/3] doc: clearer rule about formatting literals Tom Russello
2016-06-07 22:35 ` [PATCH v4 2/3] doc: change environment variables format Tom Russello
2016-06-07 22:35 ` [PATCH v4 3/3] doc: more consistency in " Tom Russello
2016-06-08 6:26 ` Matthieu Moy
2016-06-08 17:27 ` Tom Russello
2016-06-08 6:56 ` Johannes Sixt
2016-06-08 8:12 ` Matthieu Moy
2016-06-08 17:23 ` [PATCH v4 4/3] doc: change configuration " Tom Russello
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20160531162033.7137-1-erwan.mathoniere@grenoble-inp.org \
--to=erwan.mathoniere@grenoble-inp.org \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=jordan.de-gea@grenoble-inp.org \
--cc=jrnieder@gmail.com \
--cc=matthieu.moy@grenoble-inp.fr \
--cc=peff@peff.net \
--cc=rybak.a.v@gmail.com \
--cc=samuel.groot@grenoble-inp.org \
--cc=stefan@sevenbyte.org \
--cc=tom.russello@grenoble-inp.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).