threads / patch / 31457

patchdoc: move rev-list option -<n> from git-log.txt to rev-list-options.txt

Subject: [PATCH] doc: move rev-list option -<n> from git-log.txt to rev-list-options.txt

## tl;dr

4 messages between Sep 6, 2012 and Sep 8, 2012. Diffs are folded; open one to read it.

replies: 3people: 3as markdown or json

Nguyễn Thái Ngọc Duy· Sep 6, 2012, 14:28 UTC · lore

rev-list-options.txt is included in git-rev-list.txt. This makes sure rev-list man page also shows that, and at one place, together with equivalent options -n and --max-count.

Signed-off-by: Nguyễn Thái Ngọc Duy <pclouds@gmail.com>
---
 Documentation/git-log.txt          | 6 ++----
 Documentation/rev-list-options.txt | 3 ++-
 2 tập tin đã bị thay đổi, 4 được thêm vào(+), 5 bị xóa(-)

Show changes to 2 files +4 −5

Documentation/git-log.txt, Documentation/rev-list-options.txt

diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt
index 1f90620..585dac4 100644
--- a/Documentation/git-log.txt
+++ b/Documentation/git-log.txt
@@ -24,10 +24,6 @@ each commit introduces are shown.
 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
 	either <since> or <until> is omitted, it defaults to
@@ -137,6 +133,8 @@ Examples
 	This makes sense only when following a strict policy of merging all
 	topic branches when staying on a single integration branch.
 
+`git log -3`::
+	Limits the number of commits to show to 3.
 
 Discussion
 ----------
diff --git a/Documentation/rev-list-options.txt b/Documentation/rev-list-options.txt
index def1340..1b15ea9 100644
--- a/Documentation/rev-list-options.txt
+++ b/Documentation/rev-list-options.txt
@@ -8,7 +8,8 @@ ordering and formatting options, such as '--reverse'.
 
 --
 
--n 'number'::
+-<number>::
+-n <number>::
 --max-count=<number>::
 
 	Limit the number of commits to output.

-- 
1.7.12.rc2.18.g61b472e

Michael J Gruber· Sep 7, 2012, 08:50 UTC · re: Nguyễn Thái Ngọc Duy · lore

Re: [PATCH] doc: move rev-list option -<n> from git-log.txt to rev-list-options.txt

Nguyễn Thái Ngọc Duy venit, vidit, dixit 06.09.2012 16:28:

Show 9 quoted lines

> rev-list-options.txt is included in git-rev-list.txt. This makes sure
> rev-list man page also shows that, and at one place, together with
> equivalent options -n and --max-count.
> 
> Signed-off-by: Nguyễn Thái Ngọc Duy <pclouds@gmail.com>
> ---
>  Documentation/git-log.txt          | 6 ++----
>  Documentation/rev-list-options.txt | 3 ++-
>  2 tập tin đã bị thay đổi, 4 được thêm vào(+), 5 bị xóa(-)

That is one reason why "core.local=C" (repo specific) and "git -c core.locale=C" (can be used in an alias) would be useful ;)

Show 40 quoted lines

> 
> diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt
> index 1f90620..585dac4 100644
> --- a/Documentation/git-log.txt
> +++ b/Documentation/git-log.txt
> @@ -24,10 +24,6 @@ each commit introduces are shown.
>  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
>  	either <since> or <until> is omitted, it defaults to
> @@ -137,6 +133,8 @@ Examples
>  	This makes sense only when following a strict policy of merging all
>  	topic branches when staying on a single integration branch.
>  
> +`git log -3`::
> +	Limits the number of commits to show to 3.
>  
>  Discussion
>  ----------
> diff --git a/Documentation/rev-list-options.txt b/Documentation/rev-list-options.txt
> index def1340..1b15ea9 100644
> --- a/Documentation/rev-list-options.txt
> +++ b/Documentation/rev-list-options.txt
> @@ -8,7 +8,8 @@ ordering and formatting options, such as '--reverse'.
>  
>  --
>  
> --n 'number'::
> +-<number>::
> +-n <number>::
>  --max-count=<number>::
>  
>  	Limit the number of commits to output.
>

This looks OK.

I noticed though that the man pages of git-log and git-rev-list still look more different than they would need to, e.g. regarding the way limitting by paths is explained more prominently with git-log. But that may just be being more user friendly for git-log's man page than for git rev-list's, which is OK.

Michael

Junio C Hamano· Sep 7, 2012, 17:14 UTC · re: Michael J Gruber · lore

Re: [PATCH] doc: move rev-list option -<n> from git-log.txt to rev-list-options.txt

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

Show 13 quoted lines

> Nguyễn Thái Ngọc Duy venit, vidit, dixit 06.09.2012 16:28:
>> rev-list-options.txt is included in git-rev-list.txt. This makes sure
>> rev-list man page also shows that, and at one place, together with
>> equivalent options -n and --max-count.
>> 
>> Signed-off-by: Nguyễn Thái Ngọc Duy <pclouds@gmail.com>
>> ---
>>  Documentation/git-log.txt          | 6 ++----
>>  Documentation/rev-list-options.txt | 3 ++-
>>  2 tập tin đã bị thay đổi, 4 được thêm vào(+), 5 bị xóa(-)
>
> That is one reason why "core.local=C" (repo specific) and "git -c
> core.locale=C" (can be used in an alias) would be useful ;)

Or "LC_ALL=C LANG=C git format-patch ...".

It does not bother me (even though I do not read Vietnamese), but this has been brought up a few times, and we may want to revert the i18n of the diffstat summary. It does not seem to add much value to the system but annoys people. After all, the "upstream" diffstat does not localizes this string (I just checked diffstat-1.55 with Jan 2012 timestamp).

Nguyen Thai Ngoc Duy· Sep 8, 2012, 16:11 UTC · re: Junio C Hamano · lore

Re: [PATCH] doc: move rev-list option -<n> from git-log.txt to rev-list-options.txt

On Sat, Sep 8, 2012 at 12:14 AM, Junio C Hamano <gitster@pobox.com> wrote:

Show 9 quoted lines

> Michael J Gruber <git@drmicha.warpmail.net> writes:
>>>  Documentation/git-log.txt          | 6 ++----
>>>  Documentation/rev-list-options.txt | 3 ++-
>>>  2 tập tin đã bị thay đổi, 4 được thêm vào(+), 5 bị xóa(-)
>>
>> That is one reason why "core.local=C" (repo specific) and "git -c
>> core.locale=C" (can be used in an alias) would be useful ;)
>
> Or "LC_ALL=C LANG=C git format-patch ...".

The only problem is I forget to do that from time to time (and doing that bothers me too)

> It does not bother me (even though I do not read Vietnamese), but
> this has been brought up a few times, and we may want to revert the
> i18n of the diffstat summary.  It does not seem to add much value to
> the system but annoys people.

That's one step towards a better interface for non English speaking users. "git log" interface for example still shows Author, Commit, Date in English and these strings are shared with format-patch. Reverting back to English to me is a step back.

This brings back to a series I posted about two weeks ago and got no comments

http://article.gmane.org/gmane.comp.version-control.git/204285

I think it's a reasonable approach. Use English for machine interface, otherwise a native language if available.

> After all, the "upstream" diffstat
> does not localizes this string (I just checked diffstat-1.55 with
> Jan 2012 timestamp).

-- 
Duy