On Wed, May 28, 2008 at 04:56:49PM -0700, Junio C Hamano wrote:
> First a bit offtopic to avoid duplicated work. Please nobody waste your
> time sending s/See Also/SEE ALSO/ clean-up patch. I've done that already.
It is much more widespread than that. We are very inconsistent with
section title capitalization. For man pages, it doesn't matter; asciidoc
makes them all upper case. However, they end up inconsistent in the html
versions. So if we care about this, then probably everything should be
fixed.
You can get a rough idea with:
$ cd Documentation && perl -ne '
print "$ARGV:$last" if
/^-+$/ &&
length == length($last) &&
$last =~ /[a-z]/;
$last = $_;
' git-*.txt
> Now, I do not think it is customary to say anything but the name of the
> manual page if you refer to one in SEE ALSO section. I am wondering if we
> would want to remove the three-liner for consistency (but haven't done so,
> neither the short description of qgit and others in gitk manual page is
> gone yet).
It isn't how most of the pages are, but I think it is actually helpful.
And it's not as if "SEE ALSO" contents are supposed to be machine
parsable.
Though if the _reason_ that one needs to "see also" is not obvious,
perhaps it is better as part of the text of a different section (OTOH, I
think Geoffrey's patch was in response to your request to put it in the
"SEE ALSO").
-Peff
--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
