git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Miklos Vajna <vmiklos@frugalware.org>
Cc: git@vger.kernel.org
Subject: Re: [PATCH] Include rev-list options in git-log manpage.
Date: Thu, 17 Jan 2008 23:21:27 -0800	[thread overview]
Message-ID: <7vejcfiop4.fsf@gitster.siamese.dyndns.org> (raw)
In-Reply-To: <20080117214425.GP29972@genesis.frugalware.org> (Miklos Vajna's message of "Thu, 17 Jan 2008 22:44:25 +0100")

Miklos Vajna <vmiklos@frugalware.org> writes:

> It seems that all the git-rev-list options (--grep, --author, etc) were missing
> from the git-log manpage. This can be quite problematic if one does not know
> that git-log accepts the options of git-rev-list.
>
> So move these options to a separate file and include it from both
> git-rev-list.txt and git-log.txt.
>
> Signed-off-by: Miklos Vajna <vmiklos@frugalware.org>
> ---
>
> Noticed by tsuna on IRC. I hope this is okay for 1.5.4.

Have you generated documentation with and without patch and run
diff between them?

There is an obvious duplicated inclusion of pretty-options.txt[]
in git-log.{1,html}.

In addition, this part

> -Commit Formatting
> -~~~~~~~~~~~~~~~~~
> -
> -Using these options, linkgit:git-rev-list[1] will act similar to the
> -more specialized family of commit log tools: linkgit:git-log[1],
> -linkgit:git-show[1], and linkgit:git-whatchanged[1]

is _clearly_ written for git-rev-list and unsuitable for any of
the commands listed above.

git-log manual page has been saying that "This manual page
describes only the most frequently used options."  I would agree
that it is a laudable goal to replace that sentence with an
included common source text, but there needs to be a bit more
careful copyediting than your a patch.

  reply	other threads:[~2008-01-18  7:22 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2008-01-17 21:44 [PATCH] Include rev-list options in git-log manpage Miklos Vajna
2008-01-18  7:21 ` Junio C Hamano [this message]
2008-01-18 16:17   ` Miklos Vajna
2008-01-18 16:37     ` Johannes Sixt
2008-01-18 17:18       ` Miklos Vajna
2008-01-18 19:50         ` Junio C Hamano
2008-01-18 19:51         ` Junio C Hamano
2008-01-18 22:50           ` Miklos Vajna
2008-01-18 22:58             ` Miklos Vajna
2008-01-18 23:12               ` Junio C Hamano

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=7vejcfiop4.fsf@gitster.siamese.dyndns.org \
    --to=gitster@pobox.com \
    --cc=git@vger.kernel.org \
    --cc=vmiklos@frugalware.org \
    /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).