[PATCH] In Examples, explain option -r and refer to git-rev-list[1]

[PATCH] In Examples, explain option -r and refer to git-rev-list[1]

[Jari Aalto]

Signed-off-by: Jari Aalto <jari.aalto@cante.net>
---
 Documentation/git-log.txt |    3 ++-
 1 files changed, 2 insertions(+), 1 deletions(-)

diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt
index 49bb539..aa42f0e 100644
--- a/Documentation/git-log.txt
+++ b/Documentation/git-log.txt
@@ -76,7 +76,8 @@ git log -r --name-status release..test::
 
 	Show the commits that are in the "test" branch but not yet
 	in the "release" branch, along with the list of paths
-	each commit modifies.
+	each commit modifies. Opton -r (see gitlink:git-rev-list[1])
+        descends recursively.
 
 Discussion
 ----------
-- 
1.5.3.rc5

Re: [PATCH] In Examples, explain option -r and refer to git-rev-list[1]

[Lukas Sandström]

Jari Aalto wrote:
> Signed-off-by: Jari Aalto <jari.aalto@cante.net>
> ---
>  Documentation/git-log.txt |    3 ++-
>  1 files changed, 2 insertions(+), 1 deletions(-)
> 
> diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt
> index 49bb539..aa42f0e 100644
> --- a/Documentation/git-log.txt
> +++ b/Documentation/git-log.txt
> @@ -76,7 +76,8 @@ git log -r --name-status release..test::
>  
>  	Show the commits that are in the "test" branch but not yet
>  	in the "release" branch, along with the list of paths
> -	each commit modifies.
> +	each commit modifies. Opton -r (see gitlink:git-rev-list[1])
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ spelling mistake (option)

/Lukas

Re: [PATCH] In Examples, explain option -r and refer to git-rev-list[1]

[Junio C Hamano]

Lukas Sandström <lukass@etek.chalmers.se> writes:

> Jari Aalto wrote:
>> Signed-off-by: Jari Aalto <jari.aalto@cante.net>
>> ---
>>  Documentation/git-log.txt |    3 ++-
>>  1 files changed, 2 insertions(+), 1 deletions(-)
>> 
>> diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt
>> index 49bb539..aa42f0e 100644
>> --- a/Documentation/git-log.txt
>> +++ b/Documentation/git-log.txt
>> @@ -76,7 +76,8 @@ git log -r --name-status release..test::
>>  
>>  	Show the commits that are in the "test" branch but not yet
>>  	in the "release" branch, along with the list of paths
>> -	each commit modifies.
>> +	each commit modifies. Opton -r (see gitlink:git-rev-list[1])
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ spelling mistake (option)

I think it makes more sense to make Porcelain including "git
log" to always recurse in its diff operations (when diff output
is asked for), in which case the example should simply lose
the "-r" option.

But that is a post-1.5.3 change.  That's why I am planning to
drop this patch for now.

Re: [PATCH] In Examples, explain option -r and refer to git-rev-list[1]

[Junio C Hamano]

Junio C Hamano <gitster@pobox.com> writes:

> Lukas Sandström <lukass@etek.chalmers.se> writes:
>
>> Jari Aalto wrote:
>>> Signed-off-by: Jari Aalto <jari.aalto@cante.net>
>>> ---
>>>  Documentation/git-log.txt |    3 ++-
>>>  1 files changed, 2 insertions(+), 1 deletions(-)
>>> 
>>> diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt
>>> index 49bb539..aa42f0e 100644
>>> --- a/Documentation/git-log.txt
>>> +++ b/Documentation/git-log.txt
>>> @@ -76,7 +76,8 @@ git log -r --name-status release..test::
>>>  
>>>  	Show the commits that are in the "test" branch but not yet
>>>  	in the "release" branch, along with the list of paths
>>> -	each commit modifies.
>>> +	each commit modifies. Opton -r (see gitlink:git-rev-list[1])
>> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ spelling mistake (option)
>
> I think it makes more sense to make Porcelain including "git
> log" to always recurse in its diff operations (when diff output
> is asked for), in which case the example should simply lose
> the "-r" option.
>
> But that is a post-1.5.3 change.  That's why I am planning to
> drop this patch for now.

The change would probably look something like this.  Testing is
left as an exercise to the readers ;-).

---

 Documentation/git-log.txt     |    2 +-
 Documentation/user-manual.txt |    2 +-
 builtin-log.c                 |    1 +
 3 files changed, 3 insertions(+), 2 deletions(-)

diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt
index 1e6dbd9..5ec547c 100644
--- a/Documentation/git-log.txt
+++ b/Documentation/git-log.txt
@@ -96,7 +96,7 @@ git log --since="2 weeks ago" \-- gitk::
 	The "--" is necessary to avoid confusion with the *branch* named
 	'gitk'
 
-git log -r --name-status release..test::
+git log --name-status release..test::
 
 	Show the commits that are in the "test" branch but not yet
 	in the "release" branch, along with the list of paths
diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt
index 06ab79f..35298e6 100644
--- a/Documentation/user-manual.txt
+++ b/Documentation/user-manual.txt
@@ -921,7 +921,7 @@ file such that it contained the given content either before or after the
 commit.  You can find out with this:
 
 -------------------------------------------------
-$  git log --raw -r --abbrev=40 --pretty=oneline -- filename |
+$  git log --raw --abbrev=40 --pretty=oneline -- filename |
 	grep -B 1 `git hash-object filename`
 -------------------------------------------------
 
diff --git a/builtin-log.c b/builtin-log.c
index 13bae31..d6cf9d5 100644
--- a/builtin-log.c
+++ b/builtin-log.c
@@ -258,6 +258,7 @@ int cmd_log(int argc, const char **argv, const char *prefix)
 	git_config(git_log_config);
 	init_revisions(&rev, prefix);
 	rev.always_show_header = 1;
+	rev.diffopt.recursive = 1;
 	cmd_log_init(argc, argv, prefix, &rev);
 	return cmd_log_walk(&rev);
 }

Re: [PATCH] In Examples, explain option -r and refer to git-rev-list[1]

[Jeff King]

On Mon, Aug 27, 2007 at 01:33:49AM -0700, Junio C Hamano wrote:

> --- a/builtin-log.c
> +++ b/builtin-log.c
> @@ -258,6 +258,7 @@ int cmd_log(int argc, const char **argv, const char *prefix)
>  	git_config(git_log_config);
>  	init_revisions(&rev, prefix);
>  	rev.always_show_header = 1;
> +	rev.diffopt.recursive = 1;
>  	cmd_log_init(argc, argv, prefix, &rev);
>  	return cmd_log_walk(&rev);
>  }

This should perhaps rather go in cmd_log_init (and be removed from
cmd_show and cmd_whatchanged). I think this is semantically a little
more clear, and the change will affect other log porcelains (right now
just "git-reflog --name-status", but also new ones if they are added).

But yes, this is post-1.5.3, so I will shut up rather than nitpicking
your "not meant to be applied now" patches.

-Peff

Re: [PATCH] In Examples, explain option -r and refer to git-rev-list[1]

[Junio C Hamano]

Jeff King <peff@peff.net> writes:

> On Mon, Aug 27, 2007 at 01:33:49AM -0700, Junio C Hamano wrote:
>
>> --- a/builtin-log.c
>> +++ b/builtin-log.c
>> @@ -258,6 +258,7 @@ int cmd_log(int argc, const char **argv, const char *prefix)
>>  	git_config(git_log_config);
>>  	init_revisions(&rev, prefix);
>>  	rev.always_show_header = 1;
>> +	rev.diffopt.recursive = 1;
>>  	cmd_log_init(argc, argv, prefix, &rev);
>>  	return cmd_log_walk(&rev);
>>  }
>
> This should perhaps rather go in cmd_log_init (and be removed from
> cmd_show and cmd_whatchanged). I think this is semantically a little
> more clear, and the change will affect other log porcelains (right now
> just "git-reflog --name-status", but also new ones if they are added).
>
> But yes, this is post-1.5.3, so I will shut up rather than nitpicking
> your "not meant to be applied now" patches.

Thanks for your comments; rather than shutting up, could you
send an improvement after 1.5.3 happens?

Re: [PATCH] In Examples, explain option -r and refer to git-rev-list[1]

[Jeff King]

On Mon, Aug 27, 2007 at 02:55:07AM -0700, Junio C Hamano wrote:

> > But yes, this is post-1.5.3, so I will shut up rather than nitpicking
> > your "not meant to be applied now" patches.
> 
> Thanks for your comments; rather than shutting up, could you
> send an improvement after 1.5.3 happens?

Will do.

-Peff