Re: [PATCH 0/7] Some superficial documentation changes

From: Junio C Hamano <gitster@pobox.com>
Date: Jul 1, 2008, 08:42 UTC
Message-ID: <7viqvqov01.fsf@gitster.siamese.dyndns.org>
In-Reply-To: <Pine.GSO.4.62.0806301650530.7190@harper.uchicago.edu>

Jonathan Nieder <jrnieder@uchicago.edu> writes:

> But at least I was able to check that patch 6/7 (which redistributes the
> dashes in the world) doesn't touch anything but spaces and hyphens.
> Hopefully that should make this easier to review.

Yes, the earlier "line break adjustments" patch really helped.

I've queued all of them to 'pu' while reading them over, except for the last one. I did not look very carefully, but the parts I did look at made sense.

In general, I've always preferred to see command names "git-foo" typeset in teletype face, consistent with examples (also typeset in tt), because they are both something the end users are expected to type. With this transition, we are however making "git-foo" not something users are expected to type, which means that the use of a typeface that is different from the body text to spell command names is now strictly for making them stand out in context. In that sense, I share your hesitation about the last one to use tt for command names. It probably is better to use italic now.

On my next git day (coming Wednesday, if nothing goes wrong at day job), I'll merge all except the last one to 'master' so that the HTML version of the manual page k.org serves to the general public is updated and we can get a wider exposure to looking for conversion errors more easily. If you also prefer 'italics' and list agrees, it might be a better idea to also apply that patch when I do so, as that step is the most error prone one and benefits from more eyeballs.

Thanks.