From: Sergei Organov <osv@javad.com>
To: git@vger.kernel.org
Subject: git-merge: inconsistent manual page.
Date: Tue, 30 Oct 2007 16:22:31 +0300 [thread overview]
Message-ID: <fg7b6o$k1f$1@ger.gmane.org> (raw)
Hello,
git-merge has inconsistent manual page:
1. In the SYNOPSIS, there is [-m <msg>], but OPTIONS section lacks it.
The latter has just description of <msg>, suggesting it could be
used without -m, but SYNOPSIS doesn't reflect this.
BTW, git-merge options are described in
Documentation/merge-options.txt that is also used fot git-pull
options, and it's not clear for me if git-pull supports [-m
<msg>]. Does it?
2. In the SYNOPSIS, there is no <head> that is described in the
OPTIONS.
Overall, it seems that either SYNOPSIS should be changed (see patch
below), or historical syntax should be wiped from the manual page.
diff --git a/Documentation/git-merge.txt b/Documentation/git-merge.txt
index bca4212..0ea7aea 100644
--- a/Documentation/git-merge.txt
+++ b/Documentation/git-merge.txt
@@ -10,7 +10,7 @@ SYNOPSIS
--------
[verse]
'git-merge' [-n] [--summary] [--no-commit] [--squash] [-s <strategy>]...
- [-m <msg>] <remote> <remote>...
+ [[-m] <msg>] [<head>] <remote> <remote>...
DESCRIPTION
-----------
--
Sergei.
next reply other threads:[~2007-10-30 13:23 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2007-10-30 13:22 Sergei Organov [this message]
2007-10-30 18:39 ` git-merge: inconsistent manual page Junio C Hamano
2007-10-30 18:54 ` Junio C Hamano
2007-10-30 19:32 ` Sergei Organov
2007-10-31 0:05 ` 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='fg7b6o$k1f$1@ger.gmane.org' \
--to=osv@javad.com \
--cc=git@vger.kernel.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).