git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* --max-count useless with git-rev-list's --reverse
@ 2011-03-07 19:17 Ævar Arnfjörð Bjarmason
  2011-03-07 19:40 ` Shawn Pearce
  2011-03-08  8:30 ` Michael J Gruber
  0 siblings, 2 replies; 14+ messages in thread
From: Ævar Arnfjörð Bjarmason @ 2011-03-07 19:17 UTC (permalink / raw)
  To: Git Mailing List

On git.git, this works as expected, gives me the first 3 commits:

   $ git rev-list --reverse origin/master | head -n 3
    e83c5163316f89bfbde7d9ab23ca2e25604af290
    8bc9a0c769ac1df7820f2dbf8f7b7d64835e3c68
    e497ea2a9b6c378f01d092c210af20cbee762475

Why is this so useless about ignoring the --reverse option, is this my
design (these are the 3 *latest* commits):

    $ git rev-list --reverse origin/master --max-count=3
    08fd8710e277eed73a21c6c5483c57bfeb14e8a7
    6d74e5c9dbe71e2eb63c6e8862ec979e9a5f068b
    07873dc5dd67398324278ff0d7627bb1a863ba89
    $ git rev-list origin/master --max-count=3
    07873dc5dd67398324278ff0d7627bb1a863ba89
    6d74e5c9dbe71e2eb63c6e8862ec979e9a5f068b
    08fd8710e277eed73a21c6c5483c57bfeb14e8a7

>From the manpage:

   --reverse
       Output the commits in reverse order. Cannot be combined with
--walk-reflogs.

Shouldn't --reverse be applied *before* --max-count?

^ permalink raw reply	[flat|nested] 14+ messages in thread

* Re: --max-count useless with git-rev-list's --reverse
  2011-03-07 19:17 --max-count useless with git-rev-list's --reverse Ævar Arnfjörð Bjarmason
@ 2011-03-07 19:40 ` Shawn Pearce
  2011-03-08  7:35   ` Jay Soffian
  2011-03-08  8:30 ` Michael J Gruber
  1 sibling, 1 reply; 14+ messages in thread
From: Shawn Pearce @ 2011-03-07 19:40 UTC (permalink / raw)
  To: Ævar Arnfjörð Bjarmason; +Cc: Git Mailing List

On Mon, Mar 7, 2011 at 11:17, Ævar Arnfjörð Bjarmason <avarab@gmail.com> wrote:
> From the manpage:
>
>   --reverse
>       Output the commits in reverse order. Cannot be combined with
> --walk-reflogs.
>
> Shouldn't --reverse be applied *before* --max-count?

No. Its applied after, otherwise things like "git log -n 5 --reverse"
wouldn't let me review the last 5 commits in chronological order. It
also would take a long time to find the first 5 commits in a project
the size of linux-2.6. Most users don't care about the first 5 commits
of a project, but they do care about the most recent X commits that
may have occurred.

So yes, sometimes the reverse doesn't occur where you want it, but its
so rare to want the first X commits of a project's history that its
just accepted. In theory we could add a
--reverse-from-beginning-of-time flag to do what you want, but I don't
think anyone has cared enough to implement this. Most users who want
the beginning of time are OK with something like `git show $(git
rev-list --all | tail -1)`.

-- 
Shawn.

^ permalink raw reply	[flat|nested] 14+ messages in thread

* Re: --max-count useless with git-rev-list's --reverse
  2011-03-07 19:40 ` Shawn Pearce
@ 2011-03-08  7:35   ` Jay Soffian
  2011-03-08  8:34     ` Michael J Gruber
  0 siblings, 1 reply; 14+ messages in thread
From: Jay Soffian @ 2011-03-08  7:35 UTC (permalink / raw)
  To: Shawn Pearce, Ævar Arnfjörð Bjarmason; +Cc: Git Mailing List

On Mon, Mar 7, 2011 at 2:40 PM, Shawn Pearce <spearce@spearce.org> wrote:
> On Mon, Mar 7, 2011 at 11:17, Ævar Arnfjörð Bjarmason <avarab@gmail.com> wrote:
>> From the manpage:
>
> No. Its applied after, otherwise things like "git log -n 5 --reverse"

I think I was surprised the first time I tried to combine those
options as well, but in retrospect the reason is obvious. Nonetheless,
I think this has come up on the list a few time, so... Ævar, would you
mind submitting a documentation patch?

j.

^ permalink raw reply	[flat|nested] 14+ messages in thread

* Re: --max-count useless with git-rev-list's --reverse
  2011-03-07 19:17 --max-count useless with git-rev-list's --reverse Ævar Arnfjörð Bjarmason
  2011-03-07 19:40 ` Shawn Pearce
@ 2011-03-08  8:30 ` Michael J Gruber
  2011-03-08  8:31   ` [PATCH 1/3] rev-list-options.txt: typo fix Michael J Gruber
  1 sibling, 1 reply; 14+ messages in thread
From: Michael J Gruber @ 2011-03-08  8:30 UTC (permalink / raw)
  To: Ævar Arnfjörð Bjarmason; +Cc: Git Mailing List

Ævar Arnfjörð Bjarmason venit, vidit, dixit 07.03.2011 20:17:
> On git.git, this works as expected, gives me the first 3 commits:
> 
>    $ git rev-list --reverse origin/master | head -n 3
>     e83c5163316f89bfbde7d9ab23ca2e25604af290
>     8bc9a0c769ac1df7820f2dbf8f7b7d64835e3c68
>     e497ea2a9b6c378f01d092c210af20cbee762475
> 
> Why is this so useless about ignoring the --reverse option, is this my
> design (these are the 3 *latest* commits):

I don't think it's your design ;)

> 
>     $ git rev-list --reverse origin/master --max-count=3
>     08fd8710e277eed73a21c6c5483c57bfeb14e8a7
>     6d74e5c9dbe71e2eb63c6e8862ec979e9a5f068b
>     07873dc5dd67398324278ff0d7627bb1a863ba89
>     $ git rev-list origin/master --max-count=3
>     07873dc5dd67398324278ff0d7627bb1a863ba89
>     6d74e5c9dbe71e2eb63c6e8862ec979e9a5f068b
>     08fd8710e277eed73a21c6c5483c57bfeb14e8a7
> 
> From the manpage:
> 
>    --reverse
>        Output the commits in reverse order. Cannot be combined with

And that's exactly what it does - built in "tac", so to say.

> --walk-reflogs.
> 
> Shouldn't --reverse be applied *before* --max-count?

We could be clearer about the order in which these options are applied,
for example by listing the option blocks in that order and pointing out
--reverse in particular, see the upcoming little (squashable series).

Cheers,
Michael

^ permalink raw reply	[flat|nested] 14+ messages in thread

* [PATCH 1/3] rev-list-options.txt: typo fix
  2011-03-08  8:30 ` Michael J Gruber
@ 2011-03-08  8:31   ` Michael J Gruber
  2011-03-08  8:31     ` [PATCH 2/3] git-log.txt,rev-list-options.txt: -n/--max-count is commit limiting Michael J Gruber
                       ` (2 more replies)
  0 siblings, 3 replies; 14+ messages in thread
From: Michael J Gruber @ 2011-03-08  8:31 UTC (permalink / raw)
  To: git; +Cc: Ævar Arnfjörð Bjarmason

Signed-off-by: Michael J Gruber <git@drmicha.warpmail.net>
---
 Documentation/rev-list-options.txt |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)

diff --git a/Documentation/rev-list-options.txt b/Documentation/rev-list-options.txt
index 95d209c..76add13 100644
--- a/Documentation/rev-list-options.txt
+++ b/Documentation/rev-list-options.txt
@@ -165,7 +165,7 @@ limiting may be applied.
 -n 'number'::
 --max-count=<number>::
 
-	Limit the number of commits output.
+	Limit the number of commits to output.
 
 --skip=<number>::
 
-- 
1.7.4.1.299.g567d7.dirty

^ permalink raw reply related	[flat|nested] 14+ messages in thread

* [PATCH 2/3] git-log.txt,rev-list-options.txt: -n/--max-count is commit limiting
  2011-03-08  8:31   ` [PATCH 1/3] rev-list-options.txt: typo fix Michael J Gruber
@ 2011-03-08  8:31     ` Michael J Gruber
  2011-03-08 19:59       ` Junio C Hamano
  2011-03-08  8:31     ` [PATCH 3/3] git-log.txt,rev-list-options.txt: put option blocks in proper order Michael J Gruber
  2011-03-08 19:56     ` [PATCH 1/3] rev-list-options.txt: typo fix Junio C Hamano
  2 siblings, 1 reply; 14+ messages in thread
From: Michael J Gruber @ 2011-03-08  8:31 UTC (permalink / raw)
  To: git; +Cc: Ævar Arnfjörð Bjarmason

and therefore applied after commit ordering and formatting options, in
particular --reverse. Say so.

Signed-off-by: Michael J Gruber <git@drmicha.warpmail.net>
---
 Documentation/git-log.txt          |    1 +
 Documentation/rev-list-options.txt |    3 ++-
 2 files changed, 3 insertions(+), 1 deletions(-)

diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt
index ff41784..48c1715 100644
--- a/Documentation/git-log.txt
+++ b/Documentation/git-log.txt
@@ -25,6 +25,7 @@ OPTIONS
 
 -<n>::
 	Limits the number of commits to show.
+	Note that this is a commit limiting option, see below.
 
 <since>..<until>::
 	Show only commits between the named two commits.  When
diff --git a/Documentation/rev-list-options.txt b/Documentation/rev-list-options.txt
index 76add13..adcafa0 100644
--- a/Documentation/rev-list-options.txt
+++ b/Documentation/rev-list-options.txt
@@ -158,7 +158,8 @@ Commit Limiting
 
 Besides specifying a range of commits that should be listed using the
 special notations explained in the description, additional commit
-limiting may be applied.
+limiting may be applied. Note that they are applied before commit
+ordering and formatting options, such as '--reverse'.
 
 --
 
-- 
1.7.4.1.299.g567d7.dirty

^ permalink raw reply related	[flat|nested] 14+ messages in thread

* [PATCH 3/3] git-log.txt,rev-list-options.txt: put option blocks in proper order
  2011-03-08  8:31   ` [PATCH 1/3] rev-list-options.txt: typo fix Michael J Gruber
  2011-03-08  8:31     ` [PATCH 2/3] git-log.txt,rev-list-options.txt: -n/--max-count is commit limiting Michael J Gruber
@ 2011-03-08  8:31     ` Michael J Gruber
  2011-03-09 23:38       ` Junio C Hamano
  2011-03-08 19:56     ` [PATCH 1/3] rev-list-options.txt: typo fix Junio C Hamano
  2 siblings, 1 reply; 14+ messages in thread
From: Michael J Gruber @ 2011-03-08  8:31 UTC (permalink / raw)
  To: git; +Cc: Ævar Arnfjörð Bjarmason

which is the order in which they get applied:

commit limiting
commit ordering
commit formatting
diff options

Signed-off-by: Michael J Gruber <git@drmicha.warpmail.net>
---
 Documentation/git-log.txt          |    4 +-
 Documentation/rev-list-options.txt |  310 ++++++++++++++++++------------------
 2 files changed, 157 insertions(+), 157 deletions(-)

diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt
index 48c1715..6ae57dc 100644
--- a/Documentation/git-log.txt
+++ b/Documentation/git-log.txt
@@ -77,12 +77,12 @@ Common diff options
 ~~~~~~~~~~~~~~~~~~~
 
 :git-log: 1
-include::diff-options.txt[]
-
 include::rev-list-options.txt[]
 
 include::pretty-formats.txt[]
 
+include::diff-options.txt[]
+
 include::diff-generate-patch.txt[]
 
 Examples
diff --git a/Documentation/rev-list-options.txt b/Documentation/rev-list-options.txt
index adcafa0..f5a426b 100644
--- a/Documentation/rev-list-options.txt
+++ b/Documentation/rev-list-options.txt
@@ -1,158 +1,3 @@
-Commit Formatting
-~~~~~~~~~~~~~~~~~
-
-ifdef::git-rev-list[]
-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]
-endif::git-rev-list[]
-
-include::pretty-options.txt[]
-
---relative-date::
-
-	Synonym for `--date=relative`.
-
---date=(relative|local|default|iso|rfc|short|raw)::
-
-	Only takes effect for dates shown in human-readable format, such
-	as when using "--pretty". `log.date` config variable sets a default
-	value for log command's --date option.
-+
-`--date=relative` shows dates relative to the current time,
-e.g. "2 hours ago".
-+
-`--date=local` shows timestamps in user's local timezone.
-+
-`--date=iso` (or `--date=iso8601`) shows timestamps in ISO 8601 format.
-+
-`--date=rfc` (or `--date=rfc2822`) shows timestamps in RFC 2822
-format, often found in E-mail messages.
-+
-`--date=short` shows only date but not time, in `YYYY-MM-DD` format.
-+
-`--date=raw` shows the date in the internal raw git format `%s %z` format.
-+
-`--date=default` shows timestamps in the original timezone
-(either committer's or author's).
-
-ifdef::git-rev-list[]
---header::
-
-	Print the contents of the commit in raw-format; each record is
-	separated with a NUL character.
-endif::git-rev-list[]
-
---parents::
-
-	Print also the parents of the commit (in the form "commit parent...").
-	Also enables parent rewriting, see 'History Simplification' below.
-
---children::
-
-	Print also the children of the commit (in the form "commit child...").
-	Also enables parent rewriting, see 'History Simplification' below.
-
-ifdef::git-rev-list[]
---timestamp::
-	Print the raw commit timestamp.
-endif::git-rev-list[]
-
---left-right::
-
-	Mark which side of a symmetric diff a commit is reachable from.
-	Commits from the left side are prefixed with `<` and those from
-	the right with `>`.  If combined with `--boundary`, those
-	commits are prefixed with `-`.
-+
-For example, if you have this topology:
-+
------------------------------------------------------------------------
-             y---b---b  branch B
-            / \ /
-           /   .
-          /   / \
-         o---x---a---a  branch A
------------------------------------------------------------------------
-+
-you would get an output like this:
-+
------------------------------------------------------------------------
-	$ git rev-list --left-right --boundary --pretty=oneline A...B
-
-	>bbbbbbb... 3rd on b
-	>bbbbbbb... 2nd on b
-	<aaaaaaa... 3rd on a
-	<aaaaaaa... 2nd on a
-	-yyyyyyy... 1st on b
-	-xxxxxxx... 1st on a
------------------------------------------------------------------------
-
---graph::
-
-	Draw a text-based graphical representation of the commit history
-	on the left hand side of the output.  This may cause extra lines
-	to be printed in between commits, in order for the graph history
-	to be drawn properly.
-+
-This enables parent rewriting, see 'History Simplification' below.
-+
-This implies the '--topo-order' option by default, but the
-'--date-order' option may also be specified.
-
-ifdef::git-rev-list[]
---count::
-	Print a number stating how many commits would have been
-	listed, and suppress all other output.  When used together
-	with '--left-right', instead print the counts for left and
-	right commits, separated by a tab.
-endif::git-rev-list[]
-
-
-ifndef::git-rev-list[]
-Diff Formatting
-~~~~~~~~~~~~~~~
-
-Below are listed options that control the formatting of diff output.
-Some of them are specific to linkgit:git-rev-list[1], however other diff
-options may be given. See linkgit:git-diff-files[1] for more options.
-
--c::
-
-	With this option, diff output for a merge commit
-	shows the differences from each of the parents to the merge result
-	simultaneously instead of showing pairwise diff between a parent
-	and the result one at a time. Furthermore, it lists only files
-	which were modified from all parents.
-
---cc::
-
-	This flag implies the '-c' options and further compresses the
-	patch output by omitting uninteresting hunks whose contents in
-	the parents have only two variants and the merge result picks
-	one of them without modification.
-
--m::
-
-	This flag makes the merge commits show the full diff like
-	regular commits; for each merge parent, a separate log entry
-	and diff is generated. An exception is that only diff against
-	the first parent is shown when '--first-parent' option is given;
-	in that case, the output represents the changes the merge
-	brought _into_ the then-current branch.
-
--r::
-
-	Show recursive diffs.
-
--t::
-
-	Show the tree objects in the diff output. This implies '-r'.
-
--s::
-	Suppress diff output.
-endif::git-rev-list[]
-
 Commit Limiting
 ~~~~~~~~~~~~~~~
 
@@ -762,3 +607,158 @@ These options are mostly targeted for packing of git repositories.
 --do-walk::
 
 	Overrides a previous --no-walk.
+
+Commit Formatting
+~~~~~~~~~~~~~~~~~
+
+ifdef::git-rev-list[]
+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]
+endif::git-rev-list[]
+
+include::pretty-options.txt[]
+
+--relative-date::
+
+	Synonym for `--date=relative`.
+
+--date=(relative|local|default|iso|rfc|short|raw)::
+
+	Only takes effect for dates shown in human-readable format, such
+	as when using "--pretty". `log.date` config variable sets a default
+	value for log command's --date option.
++
+`--date=relative` shows dates relative to the current time,
+e.g. "2 hours ago".
++
+`--date=local` shows timestamps in user's local timezone.
++
+`--date=iso` (or `--date=iso8601`) shows timestamps in ISO 8601 format.
++
+`--date=rfc` (or `--date=rfc2822`) shows timestamps in RFC 2822
+format, often found in E-mail messages.
++
+`--date=short` shows only date but not time, in `YYYY-MM-DD` format.
++
+`--date=raw` shows the date in the internal raw git format `%s %z` format.
++
+`--date=default` shows timestamps in the original timezone
+(either committer's or author's).
+
+ifdef::git-rev-list[]
+--header::
+
+	Print the contents of the commit in raw-format; each record is
+	separated with a NUL character.
+endif::git-rev-list[]
+
+--parents::
+
+	Print also the parents of the commit (in the form "commit parent...").
+	Also enables parent rewriting, see 'History Simplification' below.
+
+--children::
+
+	Print also the children of the commit (in the form "commit child...").
+	Also enables parent rewriting, see 'History Simplification' below.
+
+ifdef::git-rev-list[]
+--timestamp::
+	Print the raw commit timestamp.
+endif::git-rev-list[]
+
+--left-right::
+
+	Mark which side of a symmetric diff a commit is reachable from.
+	Commits from the left side are prefixed with `<` and those from
+	the right with `>`.  If combined with `--boundary`, those
+	commits are prefixed with `-`.
++
+For example, if you have this topology:
++
+-----------------------------------------------------------------------
+             y---b---b  branch B
+            / \ /
+           /   .
+          /   / \
+         o---x---a---a  branch A
+-----------------------------------------------------------------------
++
+you would get an output like this:
++
+-----------------------------------------------------------------------
+	$ git rev-list --left-right --boundary --pretty=oneline A...B
+
+	>bbbbbbb... 3rd on b
+	>bbbbbbb... 2nd on b
+	<aaaaaaa... 3rd on a
+	<aaaaaaa... 2nd on a
+	-yyyyyyy... 1st on b
+	-xxxxxxx... 1st on a
+-----------------------------------------------------------------------
+
+--graph::
+
+	Draw a text-based graphical representation of the commit history
+	on the left hand side of the output.  This may cause extra lines
+	to be printed in between commits, in order for the graph history
+	to be drawn properly.
++
+This enables parent rewriting, see 'History Simplification' below.
++
+This implies the '--topo-order' option by default, but the
+'--date-order' option may also be specified.
+
+ifdef::git-rev-list[]
+--count::
+	Print a number stating how many commits would have been
+	listed, and suppress all other output.  When used together
+	with '--left-right', instead print the counts for left and
+	right commits, separated by a tab.
+endif::git-rev-list[]
+
+
+ifndef::git-rev-list[]
+Diff Formatting
+~~~~~~~~~~~~~~~
+
+Below are listed options that control the formatting of diff output.
+Some of them are specific to linkgit:git-rev-list[1], however other diff
+options may be given. See linkgit:git-diff-files[1] for more options.
+
+-c::
+
+	With this option, diff output for a merge commit
+	shows the differences from each of the parents to the merge result
+	simultaneously instead of showing pairwise diff between a parent
+	and the result one at a time. Furthermore, it lists only files
+	which were modified from all parents.
+
+--cc::
+
+	This flag implies the '-c' options and further compresses the
+	patch output by omitting uninteresting hunks whose contents in
+	the parents have only two variants and the merge result picks
+	one of them without modification.
+
+-m::
+
+	This flag makes the merge commits show the full diff like
+	regular commits; for each merge parent, a separate log entry
+	and diff is generated. An exception is that only diff against
+	the first parent is shown when '--first-parent' option is given;
+	in that case, the output represents the changes the merge
+	brought _into_ the then-current branch.
+
+-r::
+
+	Show recursive diffs.
+
+-t::
+
+	Show the tree objects in the diff output. This implies '-r'.
+
+-s::
+	Suppress diff output.
+endif::git-rev-list[]
-- 
1.7.4.1.299.g567d7.dirty

^ permalink raw reply related	[flat|nested] 14+ messages in thread

* Re: --max-count useless with git-rev-list's --reverse
  2011-03-08  7:35   ` Jay Soffian
@ 2011-03-08  8:34     ` Michael J Gruber
  0 siblings, 0 replies; 14+ messages in thread
From: Michael J Gruber @ 2011-03-08  8:34 UTC (permalink / raw)
  To: Jay Soffian
  Cc: Shawn Pearce, Ævar Arnfjörð Bjarmason,
	Git Mailing List

Jay Soffian venit, vidit, dixit 08.03.2011 08:35:
> On Mon, Mar 7, 2011 at 2:40 PM, Shawn Pearce <spearce@spearce.org> wrote:
>> On Mon, Mar 7, 2011 at 11:17, Ævar Arnfjörð Bjarmason <avarab@gmail.com> wrote:
>>> From the manpage:
>>
>> No. Its applied after, otherwise things like "git log -n 5 --reverse"
> 
> I think I was surprised the first time I tried to combine those
> options as well, but in retrospect the reason is obvious. Nonetheless,
> I think this has come up on the list a few time, so... Ævar, would you
> mind submitting a documentation patch?

Due to gmane lag, I replied to AAB's post only, but I bet you'll find
the patches.

Cheers,
Michael

^ permalink raw reply	[flat|nested] 14+ messages in thread

* Re: [PATCH 1/3] rev-list-options.txt: typo fix
  2011-03-08  8:31   ` [PATCH 1/3] rev-list-options.txt: typo fix Michael J Gruber
  2011-03-08  8:31     ` [PATCH 2/3] git-log.txt,rev-list-options.txt: -n/--max-count is commit limiting Michael J Gruber
  2011-03-08  8:31     ` [PATCH 3/3] git-log.txt,rev-list-options.txt: put option blocks in proper order Michael J Gruber
@ 2011-03-08 19:56     ` Junio C Hamano
  2011-03-09  7:07       ` Michael J Gruber
  2 siblings, 1 reply; 14+ messages in thread
From: Junio C Hamano @ 2011-03-08 19:56 UTC (permalink / raw)
  To: Michael J Gruber; +Cc: git, Ævar Arnfjörð Bjarmason

Michael J Gruber <git@drmicha.warpmail.net> writes:

> Signed-off-by: Michael J Gruber <git@drmicha.warpmail.net>
> ---
>  Documentation/rev-list-options.txt |    2 +-
>  1 files changed, 1 insertions(+), 1 deletions(-)
>
> diff --git a/Documentation/rev-list-options.txt b/Documentation/rev-list-options.txt
> index 95d209c..76add13 100644
> --- a/Documentation/rev-list-options.txt
> +++ b/Documentation/rev-list-options.txt
> @@ -165,7 +165,7 @@ limiting may be applied.
>  -n 'number'::
>  --max-count=<number>::
>  
> -	Limit the number of commits output.
> +	Limit the number of commits to output.
>  
>  --skip=<number>::

IIRC, the original was written using "output" as past particle of verb
"output" (as "output" in "the commits are output"), so strictly speaking I
don't think it is a typo.

But I like the new text better, so will apply ;-).

^ permalink raw reply	[flat|nested] 14+ messages in thread

* Re: [PATCH 2/3] git-log.txt,rev-list-options.txt: -n/--max-count is commit limiting
  2011-03-08  8:31     ` [PATCH 2/3] git-log.txt,rev-list-options.txt: -n/--max-count is commit limiting Michael J Gruber
@ 2011-03-08 19:59       ` Junio C Hamano
  2011-03-09  7:11         ` Michael J Gruber
  0 siblings, 1 reply; 14+ messages in thread
From: Junio C Hamano @ 2011-03-08 19:59 UTC (permalink / raw)
  To: Michael J Gruber; +Cc: git, Ævar Arnfjörð Bjarmason

Michael J Gruber <git@drmicha.warpmail.net> writes:

> diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt
> index ff41784..48c1715 100644
> --- a/Documentation/git-log.txt
> +++ b/Documentation/git-log.txt
> @@ -25,6 +25,7 @@ OPTIONS
>  
>  -<n>::
>  	Limits the number of commits to show.
> +	Note that this is a commit limiting option, see below.

I wonder if we should be dropping this instead, as it appears later in the
document anyway.

> diff --git a/Documentation/rev-list-options.txt b/Documentation/rev-list-options.txt
> index 76add13..adcafa0 100644
> --- a/Documentation/rev-list-options.txt
> +++ b/Documentation/rev-list-options.txt
> @@ -158,7 +158,8 @@ Commit Limiting
>  
>  Besides specifying a range of commits that should be listed using the
>  special notations explained in the description, additional commit
> -limiting may be applied.
> +limiting may be applied. Note that they are applied before commit
> +ordering and formatting options, such as '--reverse'.

This part is probably a good addition.

^ permalink raw reply	[flat|nested] 14+ messages in thread

* Re: [PATCH 1/3] rev-list-options.txt: typo fix
  2011-03-08 19:56     ` [PATCH 1/3] rev-list-options.txt: typo fix Junio C Hamano
@ 2011-03-09  7:07       ` Michael J Gruber
  0 siblings, 0 replies; 14+ messages in thread
From: Michael J Gruber @ 2011-03-09  7:07 UTC (permalink / raw)
  To: Junio C Hamano; +Cc: git, Ævar Arnfjörð Bjarmason

Junio C Hamano venit, vidit, dixit 08.03.2011 20:56:
> Michael J Gruber <git@drmicha.warpmail.net> writes:
> 
>> Signed-off-by: Michael J Gruber <git@drmicha.warpmail.net>
>> ---
>>  Documentation/rev-list-options.txt |    2 +-
>>  1 files changed, 1 insertions(+), 1 deletions(-)
>>
>> diff --git a/Documentation/rev-list-options.txt b/Documentation/rev-list-options.txt
>> index 95d209c..76add13 100644
>> --- a/Documentation/rev-list-options.txt
>> +++ b/Documentation/rev-list-options.txt
>> @@ -165,7 +165,7 @@ limiting may be applied.
>>  -n 'number'::
>>  --max-count=<number>::
>>  
>> -	Limit the number of commits output.
>> +	Limit the number of commits to output.
>>  
>>  --skip=<number>::
> 
> IIRC, the original was written using "output" as past particle of verb
> "output" (as "output" in "the commits are output"), so strictly speaking I
> don't think it is a typo.

When I switch on my "latin mode" I can recognize the participle in that
position, but only then ;)

> 
> But I like the new text better, so will apply ;-).
> 

With s/typo/grammo/ ;-)

^ permalink raw reply	[flat|nested] 14+ messages in thread

* Re: [PATCH 2/3] git-log.txt,rev-list-options.txt: -n/--max-count is commit limiting
  2011-03-08 19:59       ` Junio C Hamano
@ 2011-03-09  7:11         ` Michael J Gruber
  0 siblings, 0 replies; 14+ messages in thread
From: Michael J Gruber @ 2011-03-09  7:11 UTC (permalink / raw)
  To: Junio C Hamano; +Cc: git, Ævar Arnfjörð Bjarmason

Junio C Hamano venit, vidit, dixit 08.03.2011 20:59:
> Michael J Gruber <git@drmicha.warpmail.net> writes:
> 
>> diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt
>> index ff41784..48c1715 100644
>> --- a/Documentation/git-log.txt
>> +++ b/Documentation/git-log.txt
>> @@ -25,6 +25,7 @@ OPTIONS
>>  
>>  -<n>::
>>  	Limits the number of commits to show.
>> +	Note that this is a commit limiting option, see below.
> 
> I wonder if we should be dropping this instead, as it appears later in the
> document anyway.

It is an intended redundancy but can be dropped, of course. I just
thought that people confused by "-<n>" would not be looking further down
for yet another description of the same option unless they are pointed
to it (or the right section) explicitly.

Michael

^ permalink raw reply	[flat|nested] 14+ messages in thread

* Re: [PATCH 3/3] git-log.txt,rev-list-options.txt: put option blocks in proper order
  2011-03-08  8:31     ` [PATCH 3/3] git-log.txt,rev-list-options.txt: put option blocks in proper order Michael J Gruber
@ 2011-03-09 23:38       ` Junio C Hamano
  2011-03-10  7:50         ` Michael J Gruber
  0 siblings, 1 reply; 14+ messages in thread
From: Junio C Hamano @ 2011-03-09 23:38 UTC (permalink / raw)
  To: Michael J Gruber; +Cc: git, Ævar Arnfjörð Bjarmason

Michael J Gruber <git@drmicha.warpmail.net> writes:

> diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt
> index 48c1715..6ae57dc 100644
> --- a/Documentation/git-log.txt
> +++ b/Documentation/git-log.txt
> @@ -77,12 +77,12 @@ Common diff options
>  ~~~~~~~~~~~~~~~~~~~
>  
>  :git-log: 1
> -include::diff-options.txt[]
> -
>  include::rev-list-options.txt[]
>  
>  include::pretty-formats.txt[]
>  
> +include::diff-options.txt[]
> +
>  include::diff-generate-patch.txt[]

This is wrong.  The title "Common diff options", telling the AsciiDoc that
we are formatting for git-log manual page with ":git-log: 1" and inclusion
of diff-options.txt form a single group.  With your patch, the "Common
diff options" section will become ampty and makes AsciiDoc barf.

You would need _at least_ something like the attached patch on top, which
for now I'll squash in.

 Documentation/git-log.txt |    8 ++++----
 1 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt
index 6ae57dc..c43aa43 100644
--- a/Documentation/git-log.txt
+++ b/Documentation/git-log.txt
@@ -73,14 +73,14 @@ produced by --stat etc.
 	to be prefixed with "\-- " to separate them from options or
 	refnames.
 
-Common diff options
-~~~~~~~~~~~~~~~~~~~
-
-:git-log: 1
 include::rev-list-options.txt[]
 
 include::pretty-formats.txt[]
 
+Common diff options
+-------------------
+
+:git-log: 1
 include::diff-options.txt[]
 
 include::diff-generate-patch.txt[]

^ permalink raw reply related	[flat|nested] 14+ messages in thread

* Re: [PATCH 3/3] git-log.txt,rev-list-options.txt: put option blocks in proper order
  2011-03-09 23:38       ` Junio C Hamano
@ 2011-03-10  7:50         ` Michael J Gruber
  0 siblings, 0 replies; 14+ messages in thread
From: Michael J Gruber @ 2011-03-10  7:50 UTC (permalink / raw)
  To: Junio C Hamano; +Cc: git, Ævar Arnfjörð Bjarmason

Junio C Hamano venit, vidit, dixit 10.03.2011 00:38:
> Michael J Gruber <git@drmicha.warpmail.net> writes:
> 
>> diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt
>> index 48c1715..6ae57dc 100644
>> --- a/Documentation/git-log.txt
>> +++ b/Documentation/git-log.txt
>> @@ -77,12 +77,12 @@ Common diff options
>>  ~~~~~~~~~~~~~~~~~~~
>>  
>>  :git-log: 1
>> -include::diff-options.txt[]
>> -
>>  include::rev-list-options.txt[]
>>  
>>  include::pretty-formats.txt[]
>>  
>> +include::diff-options.txt[]
>> +
>>  include::diff-generate-patch.txt[]
> 
> This is wrong.  The title "Common diff options", telling the AsciiDoc that
> we are formatting for git-log manual page with ":git-log: 1" and inclusion
> of diff-options.txt form a single group.  With your patch, the "Common
> diff options" section will become ampty and makes AsciiDoc barf.
> 
> You would need _at least_ something like the attached patch on top, which
> for now I'll squash in.

Didn't I say "squashable series"? ;)

Seriously, I'm sorry for this blunder. I usually build Doc before
submitting Doc patches (and here more careful reading should have sufficed).

>  Documentation/git-log.txt |    8 ++++----
>  1 files changed, 4 insertions(+), 4 deletions(-)
> 
> diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt
> index 6ae57dc..c43aa43 100644
> --- a/Documentation/git-log.txt
> +++ b/Documentation/git-log.txt
> @@ -73,14 +73,14 @@ produced by --stat etc.
>  	to be prefixed with "\-- " to separate them from options or
>  	refnames.
>  
> -Common diff options
> -~~~~~~~~~~~~~~~~~~~
> -
> -:git-log: 1
>  include::rev-list-options.txt[]
>  
>  include::pretty-formats.txt[]
>  
> +Common diff options
> +-------------------
> +
> +:git-log: 1
>  include::diff-options.txt[]
>  
>  include::diff-generate-patch.txt[]

Thanks, that's what I meant, and I also meant to mark 3/3 as PATCH/RFC
because it's a larger change in the Doc for a main command.

Michael

^ permalink raw reply	[flat|nested] 14+ messages in thread

end of thread, other threads:[~2011-03-10  7:53 UTC | newest]

Thread overview: 14+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2011-03-07 19:17 --max-count useless with git-rev-list's --reverse Ævar Arnfjörð Bjarmason
2011-03-07 19:40 ` Shawn Pearce
2011-03-08  7:35   ` Jay Soffian
2011-03-08  8:34     ` Michael J Gruber
2011-03-08  8:30 ` Michael J Gruber
2011-03-08  8:31   ` [PATCH 1/3] rev-list-options.txt: typo fix Michael J Gruber
2011-03-08  8:31     ` [PATCH 2/3] git-log.txt,rev-list-options.txt: -n/--max-count is commit limiting Michael J Gruber
2011-03-08 19:59       ` Junio C Hamano
2011-03-09  7:11         ` Michael J Gruber
2011-03-08  8:31     ` [PATCH 3/3] git-log.txt,rev-list-options.txt: put option blocks in proper order Michael J Gruber
2011-03-09 23:38       ` Junio C Hamano
2011-03-10  7:50         ` Michael J Gruber
2011-03-08 19:56     ` [PATCH 1/3] rev-list-options.txt: typo fix Junio C Hamano
2011-03-09  7:07       ` Michael J Gruber

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).