Jeff King [off-list ref] writes:
On Thu, May 26, 2016 at 09:18:17AM -0700, Junio C Hamano wrote:
quoted
quoted
1. Somebody produces a patch flipping the default. The patch is
trivial, but the commit message should tell why, and try to dig up
any possible problems we might see (e.g., why wasn't this the
default? Particular versions of tools? Some platforms?)
[...]
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.
quoted
quoted
2. Assuming no problems, Junio merges the patch to "next". We get
any reports of issues from people using "next" day-to-day.
So I can do these steps myself up to this point. After waiting for
a few days to see if somebody else with better memory tells me what
I forgot, perhaps.
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
git://git.kernel.org/pub/scm/git/git-manpages.git/
git://repo.or.cz/git-manpages.git/
git://github.com/gitster/git-manpages.git/
On Thu, May 26, 2016 at 09:37:19AM -0700, Junio C Hamano wrote:
quoted
quoted
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.
quoted
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
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 <redacted>
Signed-off-by: Samuel GROOT <redacted>
Signed-off-by: Tom RUSSELLO <redacted>
Signed-off-by: Matthieu MOY <redacted>
---
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