From: Jeff King <peff@peff.net>
To: Junio C Hamano <gitster@pobox.com>
Cc: Geoffrey Irving <irving@naml.us>, git@vger.kernel.org
Subject: Re: cherry picking changesets instead of commits
Date: Wed, 28 May 2008 20:12:17 -0400 [thread overview]
Message-ID: <20080529001216.GA17938@sigill.intra.peff.net> (raw)
In-Reply-To: <7vbq2qrni6.fsf@gitster.siamese.dyndns.org>
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
next prev parent reply other threads:[~2008-05-29 0:13 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2008-05-28 18:06 cherry picking changesets instead of commits Geoffrey Irving
2008-05-28 18:19 ` Junio C Hamano
2008-05-28 18:28 ` Geoffrey Irving
2008-05-28 18:46 ` Junio C Hamano
2008-05-28 19:42 ` Geoffrey Irving
2008-05-28 20:46 ` Junio C Hamano
2008-05-28 21:14 ` Geoffrey Irving
2008-05-28 22:38 ` Jeff King
2008-05-28 22:48 ` Jeff King
2008-05-28 23:56 ` Junio C Hamano
2008-05-29 0:12 ` Jeff King [this message]
2008-05-29 0:04 ` [PATCH] Documentation: git-cherry uses git-patch-id Junio C Hamano
2008-05-29 0:07 ` Geoffrey Irving
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20080529001216.GA17938@sigill.intra.peff.net \
--to=peff@peff.net \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=irving@naml.us \
/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.
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 NNTP newsgroup(s).