Thread (5 messages) flat view 5 messages, 2 authors, 2016-06-15

Re: [PATCH] git-push.txt: describe how to default to pushing only current branch

From: Jeff King <hidden>
Date: 2016-06-15 22:46:23

Possibly related (same subject, not in this thread)

On Fri, Mar 13, 2009 at 08:27:31PM -0500, Chris Johnsen wrote:
In the resulting manpage the inline commands are not very
obvious (the HTML looks OK though). There is some sort of
formatting in there, but it does not seem to display any
differently from the surrounding text when I use man to view it
on my system.  Would it be better to do something like wrap
double quotes around the inline commands to help readers viewing
the manpage?
The problem is that they are supposed to set in a monospaced font, but
most terminals are already monospaced. This is actually a problem
throughout the documentation, although it is usually only for
single-word phrases (like `git-foo`), which don't look nearly as bad as
multi-word ones.

Actually, looking closer, the information seems to be lost entirely.
Asciidoc renders this to <literal> in the XML, but docbook seems to
throw it away when converting to a manpage. In theory it's possible to
apply our own xsl style to turn this into something else, and I think
that is a better solution than just trying to fix this one spot.

The question is how it _should_ be rendered. Monospace isn't really
useful for terminals. Maybe simply putting quotation marks around it
would cover all situations (I'm worried it will look funny for
single-word instances).


On Sat, Mar 14, 2009 at 12:26:41PM -0700, Junio C Hamano wrote:
The new text looks reasonable.  Sign-off?

Any improvement suggestions from others?
It looks fine to me; my only concern is the typesetting, but I think
that should be fixed elsewhere, as outlined above.

-Peff
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help