git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
* [PATCH 0/3] some documentation changes from the beginning of the alphabet
@ 2018-09-19 20:12 Frederick Eaton
  2018-09-19 20:12 ` [PATCH 1/3] git-archimport.1: specify what kind of Arch we're talking about Frederick Eaton
                   ` (3 more replies)
  0 siblings, 4 replies; 15+ messages in thread
From: Frederick Eaton @ 2018-09-19 20:12 UTC (permalink / raw)
  To: Junio C Hamano; +Cc: git, Frederick Eaton

I've never sent patches using git before so I thought it would be
useful to make a small test.

I read ./Documentation/SubmittingPatches and I sent these to myself
and practiced applying them using `git am`, and I also compiled and
checked the revised manual pages to see that they format correctly.
Unfortunately it was too late to run 'git diff --check' because I had
already committed the changes to my repo, but I don't see any
whitespace highlighted when I run 'git log -p'.

I'm sure I'm doing something wrong, so please let me know what it is!

Here's the command I'll use to send the messages (without --dry-run):

git send-email --to "Junio C Hamano <gitster@pobox.com>" --cc git@vger.kernel.org --cc-cmd ./contrib/contacts/git-contacts outgoing/ --dry-run

By the way for some reason git-contacts shows more names when I run it
on the patch hash than when I give it the patch name:

$ ./contrib/contacts/git-contacts 222580cb60ee64f7b81fed64ec8fbfc81952557f
Sébastien Guimmara <sebastien.guimmara@gmail.com>
Nguyễn Thái Ngọc Duy <pclouds@gmail.com>
Eric Sunshine <sunshine@sunshineco.com>
Junio C Hamano <gitster@pobox.com>
$ ./contrib/contacts/git-contacts ./outgoing/0002-git-column.1-clarify-initial-description-provide-exa.patch                                
Junio C Hamano <gitster@pobox.com>

Not sure what's going on here, but the changes I propose seem fairly
straightforward...(?)

Frederick Eaton (3):
  git-archimport.1: specify what kind of Arch we're talking about
  git-column.1: clarify initial description, provide examples
  git-describe.1: clarify that "human readable" is also git-readable

 Documentation/git-archimport.txt |  5 +++--
 Documentation/git-column.txt     | 35 ++++++++++++++++++++++++++++++--
 Documentation/git-describe.txt   |  4 +++-
 3 files changed, 39 insertions(+), 5 deletions(-)

-- 
2.19.0


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

* [PATCH 1/3] git-archimport.1: specify what kind of Arch we're talking about
  2018-09-19 20:12 [PATCH 0/3] some documentation changes from the beginning of the alphabet Frederick Eaton
@ 2018-09-19 20:12 ` Frederick Eaton
  2018-09-19 22:59   ` Junio C Hamano
  2018-09-19 20:12 ` [PATCH 2/3] git-column.1: clarify initial description, provide examples Frederick Eaton
                   ` (2 subsequent siblings)
  3 siblings, 1 reply; 15+ messages in thread
From: Frederick Eaton @ 2018-09-19 20:12 UTC (permalink / raw)
  To: Junio C Hamano; +Cc: git, Frederick Eaton

Is it a CPU architecture? Is it Arch Linux? If you search for "arch
repository", nothing relevant comes up. Let's call it GNU Arch so
people can find it with search engines.

Signed-off-by: Frederick Eaton <frederik@ofb.net>
---
 Documentation/git-archimport.txt | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/Documentation/git-archimport.txt b/Documentation/git-archimport.txt
index ea7065336..a595a0ffe 100644
--- a/Documentation/git-archimport.txt
+++ b/Documentation/git-archimport.txt
@@ -3,7 +3,7 @@ git-archimport(1)
 
 NAME
 ----
-git-archimport - Import an Arch repository into Git
+git-archimport - Import a GNU Arch repository into Git
 
 
 SYNOPSIS
@@ -14,7 +14,8 @@ SYNOPSIS
 
 DESCRIPTION
 -----------
-Imports a project from one or more Arch repositories. It will follow branches
+Imports a project from one or more GNU Arch repositories.
+It will follow branches
 and repositories within the namespaces defined by the <archive/branch>
 parameters supplied. If it cannot find the remote branch a merge comes from
 it will just import it as a regular commit. If it can find it, it will mark it
-- 
2.19.0


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

* [PATCH 2/3] git-column.1: clarify initial description, provide examples
  2018-09-19 20:12 [PATCH 0/3] some documentation changes from the beginning of the alphabet Frederick Eaton
  2018-09-19 20:12 ` [PATCH 1/3] git-archimport.1: specify what kind of Arch we're talking about Frederick Eaton
@ 2018-09-19 20:12 ` Frederick Eaton
  2018-09-19 22:59   ` Junio C Hamano
  2018-09-19 20:12 ` [PATCH 3/3] git-describe.1: clarify that "human readable" is also git-readable Frederick Eaton
  2018-09-19 22:49 ` [PATCH 0/3] some documentation changes from the beginning of the alphabet Junio C Hamano
  3 siblings, 1 reply; 15+ messages in thread
From: Frederick Eaton @ 2018-09-19 20:12 UTC (permalink / raw)
  To: Junio C Hamano; +Cc: git, Frederick Eaton

When I read this man page I couldn't figure out what kind of input it
was referring to, or how input was being put into columns, or where I
should look for the syntax of the --mode option.

Signed-off-by: Frederick Eaton <frederik@ofb.net>
---
 Documentation/git-column.txt | 35 +++++++++++++++++++++++++++++++++--
 1 file changed, 33 insertions(+), 2 deletions(-)

diff --git a/Documentation/git-column.txt b/Documentation/git-column.txt
index 03d18465d..5bbb51068 100644
--- a/Documentation/git-column.txt
+++ b/Documentation/git-column.txt
@@ -13,7 +13,10 @@ SYNOPSIS
 
 DESCRIPTION
 -----------
-This command formats its input into multiple columns.
+This command formats the lines of its standard input into a table with
+multiple columns. Each input line occupies one cell of the table. It
+is used internally by other git commands to format output into
+columns.
 
 OPTIONS
 -------
@@ -23,7 +26,7 @@ OPTIONS
 
 --mode=<mode>::
 	Specify layout mode. See configuration variable column.ui for option
-	syntax.
+	syntax (in git-config(1)).
 
 --raw-mode=<n>::
 	Same as --mode but take mode encoded as a number. This is mainly used
@@ -43,6 +46,34 @@ OPTIONS
 --padding=<N>::
 	The number of spaces between columns. One space by default.
 
+EXAMPLES
+------
+
+Format data by columns:
+------------
+$ seq 1 24 | git column --mode=column --padding=5
+1      4      7      10     13     16     19     22
+2      5      8      11     14     17     20     23
+3      6      9      12     15     18     21     24
+------------
+
+Format data by rows:
+------------
+$ seq 1 21 | git column --mode=row --padding=5
+1      2      3      4      5      6      7
+8      9      10     11     12     13     14
+15     16     17     18     19     20     21
+------------
+
+List some tags in a table with unequal column widths:
+------------
+$ git tag --list 'v2.4.*' --column=row,dense
+v2.4.0  v2.4.0-rc0  v2.4.0-rc1  v2.4.0-rc2  v2.4.0-rc3
+v2.4.1  v2.4.10     v2.4.11     v2.4.12     v2.4.2
+v2.4.3  v2.4.4      v2.4.5      v2.4.6      v2.4.7
+v2.4.8  v2.4.9
+------------
+
 GIT
 ---
 Part of the linkgit:git[1] suite
-- 
2.19.0


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

* [PATCH 3/3] git-describe.1: clarify that "human readable" is also git-readable
  2018-09-19 20:12 [PATCH 0/3] some documentation changes from the beginning of the alphabet Frederick Eaton
  2018-09-19 20:12 ` [PATCH 1/3] git-archimport.1: specify what kind of Arch we're talking about Frederick Eaton
  2018-09-19 20:12 ` [PATCH 2/3] git-column.1: clarify initial description, provide examples Frederick Eaton
@ 2018-09-19 20:12 ` Frederick Eaton
  2018-09-19 22:49 ` [PATCH 0/3] some documentation changes from the beginning of the alphabet Junio C Hamano
  3 siblings, 0 replies; 15+ messages in thread
From: Frederick Eaton @ 2018-09-19 20:12 UTC (permalink / raw)
  To: Junio C Hamano; +Cc: git, Frederick Eaton

The caption uses the term "human readable", but the DESCRIPTION did
not explain this in context.

Signed-off-by: Frederick Eaton <frederik@ofb.net>
---
 Documentation/git-describe.txt | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/Documentation/git-describe.txt b/Documentation/git-describe.txt
index e027fb8c4..ccdc5f83d 100644
--- a/Documentation/git-describe.txt
+++ b/Documentation/git-describe.txt
@@ -18,7 +18,9 @@ The command finds the most recent tag that is reachable from a
 commit.  If the tag points to the commit, then only the tag is
 shown.  Otherwise, it suffixes the tag name with the number of
 additional commits on top of the tagged object and the
-abbreviated object name of the most recent commit.
+abbreviated object name of the most recent commit. The result
+is a "human-readable" object name which can also be used to
+identify the commit to other git commands.
 
 By default (without --all or --tags) `git describe` only shows
 annotated tags.  For more information about creating annotated tags
-- 
2.19.0


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

* Re: [PATCH 0/3] some documentation changes from the beginning of the alphabet
  2018-09-19 20:12 [PATCH 0/3] some documentation changes from the beginning of the alphabet Frederick Eaton
                   ` (2 preceding siblings ...)
  2018-09-19 20:12 ` [PATCH 3/3] git-describe.1: clarify that "human readable" is also git-readable Frederick Eaton
@ 2018-09-19 22:49 ` Junio C Hamano
  2018-09-21  5:18   ` Eric Sunshine
  3 siblings, 1 reply; 15+ messages in thread
From: Junio C Hamano @ 2018-09-19 22:49 UTC (permalink / raw)
  To: Frederick Eaton; +Cc: git

Frederick Eaton <frederik@ofb.net> writes:

> I've never sent patches using git before so I thought it would be
> useful to make a small test.

... eh, welcome ;-)

> I read ./Documentation/SubmittingPatches and I sent these to myself
> and practiced applying them using `git am`, and I also compiled and
> checked the revised manual pages to see that they format correctly.
> Unfortunately it was too late to run 'git diff --check' because I had
> already committed the changes to my repo, but I don't see any
> whitespace highlighted when I run 'git log -p'.

Thanks for being diligent.

> By the way for some reason git-contacts shows more names when I run it
> on the patch hash than when I give it the patch name:
>
> $ ./contrib/contacts/git-contacts 222580cb60ee64f7b81fed64ec8fbfc81952557f
> Sébastien Guimmara <sebastien.guimmara@gmail.com>
> Nguyễn Thái Ngọc Duy <pclouds@gmail.com>
> Eric Sunshine <sunshine@sunshineco.com>
> Junio C Hamano <gitster@pobox.com>
> $ ./contrib/contacts/git-contacts ./outgoing/0002-git-column.1-clarify-initial-description-provide-exa.patch                                
> Junio C Hamano <gitster@pobox.com>

I've never trusted what git-contacts say, but the latter one
certainly looks strange, as

	git log --no-merges Documentation/git-column.txt

makes it clear that I have nothing to do with it ;-).  Perhaps the
tool gives too much credit for Signed-off-by: footer, or something.

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

* Re: [PATCH 1/3] git-archimport.1: specify what kind of Arch we're talking about
  2018-09-19 20:12 ` [PATCH 1/3] git-archimport.1: specify what kind of Arch we're talking about Frederick Eaton
@ 2018-09-19 22:59   ` Junio C Hamano
  2018-09-19 23:13     ` frederik
  0 siblings, 1 reply; 15+ messages in thread
From: Junio C Hamano @ 2018-09-19 22:59 UTC (permalink / raw)
  To: Frederick Eaton; +Cc: git

Frederick Eaton <frederik@ofb.net> writes:

> Is it a CPU architecture? Is it Arch Linux? If you search for "arch
> repository", nothing relevant comes up. Let's call it GNU Arch so
> people can find it with search engines.
>
> Signed-off-by: Frederick Eaton <frederik@ofb.net>
> ---
>  Documentation/git-archimport.txt | 5 +++--
>  1 file changed, 3 insertions(+), 2 deletions(-)

I think "Is it a CPU archtecture?" is a red-herring, but between
"What is an Arch Repository?" and "What is GNU Arch?" there indeed
is a vast difference in the quality of information readers would
get; with the proposed commit log message that ends with "so people
can find it with search engines", I am reasonably sure this is an
improvement worth having.

Thanks.

>
> diff --git a/Documentation/git-archimport.txt b/Documentation/git-archimport.txt
> index ea7065336..a595a0ffe 100644
> --- a/Documentation/git-archimport.txt
> +++ b/Documentation/git-archimport.txt
> @@ -3,7 +3,7 @@ git-archimport(1)
>  
>  NAME
>  ----
> -git-archimport - Import an Arch repository into Git
> +git-archimport - Import a GNU Arch repository into Git
>  
>  
>  SYNOPSIS
> @@ -14,7 +14,8 @@ SYNOPSIS
>  
>  DESCRIPTION
>  -----------
> -Imports a project from one or more Arch repositories. It will follow branches
> +Imports a project from one or more GNU Arch repositories.
> +It will follow branches
>  and repositories within the namespaces defined by the <archive/branch>
>  parameters supplied. If it cannot find the remote branch a merge comes from
>  it will just import it as a regular commit. If it can find it, it will mark it

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

* Re: [PATCH 2/3] git-column.1: clarify initial description, provide examples
  2018-09-19 20:12 ` [PATCH 2/3] git-column.1: clarify initial description, provide examples Frederick Eaton
@ 2018-09-19 22:59   ` Junio C Hamano
  2018-09-20 16:23     ` Duy Nguyen
  0 siblings, 1 reply; 15+ messages in thread
From: Junio C Hamano @ 2018-09-19 22:59 UTC (permalink / raw)
  To: Nguyễn Thái Ngọc Duy; +Cc: git, Frederick Eaton

Frederick Eaton <frederik@ofb.net> writes:

> When I read this man page I couldn't figure out what kind of input it
> was referring to, or how input was being put into columns, or where I
> should look for the syntax of the --mode option.
>
> Signed-off-by: Frederick Eaton <frederik@ofb.net>
> ---
>  Documentation/git-column.txt | 35 +++++++++++++++++++++++++++++++++--
>  1 file changed, 33 insertions(+), 2 deletions(-)

I'll defer this to its primary author.

>
> diff --git a/Documentation/git-column.txt b/Documentation/git-column.txt
> index 03d18465d..5bbb51068 100644
> --- a/Documentation/git-column.txt
> +++ b/Documentation/git-column.txt
> @@ -13,7 +13,10 @@ SYNOPSIS
>  
>  DESCRIPTION
>  -----------
> -This command formats its input into multiple columns.
> +This command formats the lines of its standard input into a table with
> +multiple columns. Each input line occupies one cell of the table. It
> +is used internally by other git commands to format output into
> +columns.
>  
>  OPTIONS
>  -------
> @@ -23,7 +26,7 @@ OPTIONS
>  
>  --mode=<mode>::
>  	Specify layout mode. See configuration variable column.ui for option
> -	syntax.
> +	syntax (in git-config(1)).
>  
>  --raw-mode=<n>::
>  	Same as --mode but take mode encoded as a number. This is mainly used
> @@ -43,6 +46,34 @@ OPTIONS
>  --padding=<N>::
>  	The number of spaces between columns. One space by default.
>  
> +EXAMPLES
> +------
> +
> +Format data by columns:
> +------------
> +$ seq 1 24 | git column --mode=column --padding=5
> +1      4      7      10     13     16     19     22
> +2      5      8      11     14     17     20     23
> +3      6      9      12     15     18     21     24
> +------------
> +
> +Format data by rows:
> +------------
> +$ seq 1 21 | git column --mode=row --padding=5
> +1      2      3      4      5      6      7
> +8      9      10     11     12     13     14
> +15     16     17     18     19     20     21
> +------------
> +
> +List some tags in a table with unequal column widths:
> +------------
> +$ git tag --list 'v2.4.*' --column=row,dense
> +v2.4.0  v2.4.0-rc0  v2.4.0-rc1  v2.4.0-rc2  v2.4.0-rc3
> +v2.4.1  v2.4.10     v2.4.11     v2.4.12     v2.4.2
> +v2.4.3  v2.4.4      v2.4.5      v2.4.6      v2.4.7
> +v2.4.8  v2.4.9
> +------------
> +
>  GIT
>  ---
>  Part of the linkgit:git[1] suite

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

* Re: [PATCH 1/3] git-archimport.1: specify what kind of Arch we're talking about
  2018-09-19 22:59   ` Junio C Hamano
@ 2018-09-19 23:13     ` frederik
  0 siblings, 0 replies; 15+ messages in thread
From: frederik @ 2018-09-19 23:13 UTC (permalink / raw)
  To: Junio C Hamano; +Cc: git

> I think "Is it a CPU archtecture?" is a red-herring, but between

It wasn't meant to be a red-herring though. Plenty of Linux
distributions have different architecture-specific package repos, and
arch is a common abbreviation for architecture. This only comes up if
you search for the full word e.g. "linux architecture repository"
since other wise Arch Linux dominates all the search results.

A bit of a tangent...

Frederick

> "What is an Arch Repository?" and "What is GNU Arch?" there indeed
> is a vast difference in the quality of information readers would
> get; with the proposed commit log message that ends with "so people
> can find it with search engines", I am reasonably sure this is an
> improvement worth having.
> 
> Thanks.

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

* Re: [PATCH 2/3] git-column.1: clarify initial description, provide examples
  2018-09-19 22:59   ` Junio C Hamano
@ 2018-09-20 16:23     ` Duy Nguyen
  2018-09-20 17:47       ` frederik
  0 siblings, 1 reply; 15+ messages in thread
From: Duy Nguyen @ 2018-09-20 16:23 UTC (permalink / raw)
  To: Frederick Eaton; +Cc: git, Frederick Eaton, Junio C Hamano

On Wed, Sep 19, 2018 at 03:59:58PM -0700, Junio C Hamano wrote:
> > @@ -23,7 +26,7 @@ OPTIONS
> >  
> >  --mode=<mode>::
> >  	Specify layout mode. See configuration variable column.ui for option
> > -	syntax.
> > +	syntax (in git-config(1)).

I think we usually link to other commands with "linkgit", like
linkgit:git-config[1]

Other than that, the rest looks good.
--
Duy

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

* Re: [PATCH 2/3] git-column.1: clarify initial description, provide examples
  2018-09-20 16:23     ` Duy Nguyen
@ 2018-09-20 17:47       ` frederik
  2018-09-21  5:32         ` Eric Sunshine
  2018-09-21 16:32         ` Junio C Hamano
  0 siblings, 2 replies; 15+ messages in thread
From: frederik @ 2018-09-20 17:47 UTC (permalink / raw)
  To: Duy Nguyen; +Cc: git, Junio C Hamano

On Thu, Sep 20, 2018 at 06:23:03PM +0200, Duy Nguyen wrote:
> On Wed, Sep 19, 2018 at 03:59:58PM -0700, Junio C Hamano wrote:
> > > @@ -23,7 +26,7 @@ OPTIONS
> > >  
> > >  --mode=<mode>::
> > >  	Specify layout mode. See configuration variable column.ui for option
> > > -	syntax.
> > > +	syntax (in git-config(1)).
> 
> I think we usually link to other commands with "linkgit", like
> linkgit:git-config[1]
> 
> Other than that, the rest looks good.

Thank you, then do I edit the patch and resubmit as PATCH v2 with the
message ID and all that?

Frederick

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

* Re: [PATCH 0/3] some documentation changes from the beginning of the alphabet
  2018-09-19 22:49 ` [PATCH 0/3] some documentation changes from the beginning of the alphabet Junio C Hamano
@ 2018-09-21  5:18   ` Eric Sunshine
  2018-09-21  5:45     ` frederik
  0 siblings, 1 reply; 15+ messages in thread
From: Eric Sunshine @ 2018-09-21  5:18 UTC (permalink / raw)
  To: Junio C Hamano; +Cc: Frederick Eaton, Git List

On Wed, Sep 19, 2018 at 6:49 PM Junio C Hamano <gitster@pobox.com> wrote:
> Frederick Eaton <frederik@ofb.net> writes:
> > By the way for some reason git-contacts shows more names when I run it
> > on the patch hash than when I give it the patch name:
> >
> > $ ./contrib/contacts/git-contacts 222580cb60ee64f7b81fed64ec8fbfc81952557f
> > Sébastien Guimmara <sebastien.guimmara@gmail.com>
> > Nguyễn Thái Ngọc Duy <pclouds@gmail.com>
> > Eric Sunshine <sunshine@sunshineco.com>
> > Junio C Hamano <gitster@pobox.com>
> > $ ./contrib/contacts/git-contacts ./outgoing/0002-git-column.1-clarify-initial-description-provide-exa.patch
> > Junio C Hamano <gitster@pobox.com>
>
> I've never trusted what git-contacts say, but the latter one
> certainly looks strange [...]

I don't use git-contacts, but the first invocation isn't consulting
just a single commit but rather a range of commits. From git-contacts
documentation:

    Input consists of one or more patch files or revision arguments.
    A revision argument can be a range or a single `<rev>` which is
    interpreted as `<rev>..HEAD`, thus the same revision arguments
    are accepted as for linkgit:git-format-patch[1]. Patch files and
    revision arguments can be combined in the same invocation.

So, you are actually running git-contacts on the range 222580cb..HEAD,
and 222580cb isn't even one of the patches being consulted (due to how
the range syntax does not include the argument to the left of "..").
To consult just that one commit, you'd want perhaps:

    git-contacts 222580cb^..222580cb

> [...] as,
>
>         git log --no-merges Documentation/git-column.txt
>
> makes it clear that I have nothing to do with it ;-).  Perhaps the
> tool gives too much credit for Signed-off-by: footer, or something.

Since git-contacts can be used as git-send-email's --cc-cmd, it can
potentially be invoked many times, and it's a slow command (due to all
the "blaming" via git-blame). As an optimization, git-contacts limits
the timeframe of the blame via git-blame's --since option, with a
hardcoded limit of 5 years. So, the git-blame invocation made by
git-contacts for this patch file is:

    git blame --porcelain -C -L13,+7 -L23,+7 -L43,+6 \
        --since 5-years-ago \
        4a189fff51b1^ -- Documentation/git-column.txt

Since the lines changed by the patch have not been touched within that
timeframe, git-blame assigns those lines to boundary commit 128a96c984
(Update draft release notes to 1.8.5 for the fifth batch of topics,
2013-09-20), which was authored by Junio, which is why he shows up as
the only "contact".

If we remove the --since restriction:

    git blame --porcelain -C -L13,+7 -L23,+7 -L43,+6 \
        4a189fff51b1^ -- Documentation/git-column.txt

then the lines are correctly "blamed" to Duy via commit 7e29b8254f
(Add column layout skeleton and git-column, 2012-04-21).

The "Limitations" section of the git-contacts documentation says this:

    Several conditions controlling a person's significance are
    currently hard-coded, such as minimum participation level (10%),
    blame date-limiting (5 years), and `-C` level for detecting moved
    and copied lines (a single `-C`). In the future, these conditions
    may become configurable.

So, this sort of potential issue was understood. Felipe's
git-related[1], from which git-contacts arose, eventually grew the
ability to tweak these hard-coded values via command-line options. The
same could be done for git-contacts. Patches are welcome.

[1]: https://github.com/felipec/git-related

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

* Re: [PATCH 2/3] git-column.1: clarify initial description, provide examples
  2018-09-20 17:47       ` frederik
@ 2018-09-21  5:32         ` Eric Sunshine
  2018-09-21 16:32         ` Junio C Hamano
  1 sibling, 0 replies; 15+ messages in thread
From: Eric Sunshine @ 2018-09-21  5:32 UTC (permalink / raw)
  To: Frederick Eaton
  Cc: Nguyễn Thái Ngọc Duy, Git List, Junio C Hamano

On Thu, Sep 20, 2018 at 1:47 PM <frederik@ofb.net> wrote:
> On Thu, Sep 20, 2018 at 06:23:03PM +0200, Duy Nguyen wrote:
> > On Wed, Sep 19, 2018 at 03:59:58PM -0700, Junio C Hamano wrote:
> > > > @@ -23,7 +26,7 @@ OPTIONS
> > > >
> > > >  --mode=<mode>::
> > > >   Specify layout mode. See configuration variable column.ui for option
> > > > - syntax.
> > > > + syntax (in git-config(1)).
> >
> > I think we usually link to other commands with "linkgit", like
> > linkgit:git-config[1]
>
> Thank you, then do I edit the patch and resubmit as PATCH v2 with the
> message ID and all that?

Editing the patch directly is not recommended. More typical would be
to use "git rebase -i" and/or "git commit --amend" to make changes to
the commits themselves (that is, rewrite history), taking review
comments into account (and generally polishing the changes). Once the
edits are complete, re-generate the patches with git-format-patch and
re-send the entire series as v2 with git-send-email (or some people
skip git-format-patch and go directly to git-send-email to both format
and send the patches as one step).

You can use the -v option of git-format-patch to mark the series as v2.

When sending v2 via git-send-email, you can use the --in-reply-to
option with the message ID of the v1 cover letter to tie the re-roll
to the original. (The message ID of the v1 cover letter is
"20180919201231.609-1-frederik@ofb.net".)

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

* Re: [PATCH 0/3] some documentation changes from the beginning of the alphabet
  2018-09-21  5:18   ` Eric Sunshine
@ 2018-09-21  5:45     ` frederik
  0 siblings, 0 replies; 15+ messages in thread
From: frederik @ 2018-09-21  5:45 UTC (permalink / raw)
  To: Eric Sunshine; +Cc: Junio C Hamano, Git List

> Patches are welcome.

I'd be happy to patch git-contacts to link to the message you just
sent, then maybe someone more qualified would know where to start... :)

Frederick

On Fri, Sep 21, 2018 at 01:18:30AM -0400, Eric Sunshine wrote:
> On Wed, Sep 19, 2018 at 6:49 PM Junio C Hamano <gitster@pobox.com> wrote:
> > Frederick Eaton <frederik@ofb.net> writes:
> > > By the way for some reason git-contacts shows more names when I run it
> > > on the patch hash than when I give it the patch name:
> > >
> > > $ ./contrib/contacts/git-contacts 222580cb60ee64f7b81fed64ec8fbfc81952557f
> > > Sébastien Guimmara <sebastien.guimmara@gmail.com>
> > > Nguyễn Thái Ngọc Duy <pclouds@gmail.com>
> > > Eric Sunshine <sunshine@sunshineco.com>
> > > Junio C Hamano <gitster@pobox.com>
> > > $ ./contrib/contacts/git-contacts ./outgoing/0002-git-column.1-clarify-initial-description-provide-exa.patch
> > > Junio C Hamano <gitster@pobox.com>
> >
> > I've never trusted what git-contacts say, but the latter one
> > certainly looks strange [...]
> 
> I don't use git-contacts, but the first invocation isn't consulting
> just a single commit but rather a range of commits. From git-contacts
> documentation:
> 
>     Input consists of one or more patch files or revision arguments.
>     A revision argument can be a range or a single `<rev>` which is
>     interpreted as `<rev>..HEAD`, thus the same revision arguments
>     are accepted as for linkgit:git-format-patch[1]. Patch files and
>     revision arguments can be combined in the same invocation.
> 
> So, you are actually running git-contacts on the range 222580cb..HEAD,
> and 222580cb isn't even one of the patches being consulted (due to how
> the range syntax does not include the argument to the left of "..").
> To consult just that one commit, you'd want perhaps:
> 
>     git-contacts 222580cb^..222580cb
> 
> > [...] as,
> >
> >         git log --no-merges Documentation/git-column.txt
> >
> > makes it clear that I have nothing to do with it ;-).  Perhaps the
> > tool gives too much credit for Signed-off-by: footer, or something.
> 
> Since git-contacts can be used as git-send-email's --cc-cmd, it can
> potentially be invoked many times, and it's a slow command (due to all
> the "blaming" via git-blame). As an optimization, git-contacts limits
> the timeframe of the blame via git-blame's --since option, with a
> hardcoded limit of 5 years. So, the git-blame invocation made by
> git-contacts for this patch file is:
> 
>     git blame --porcelain -C -L13,+7 -L23,+7 -L43,+6 \
>         --since 5-years-ago \
>         4a189fff51b1^ -- Documentation/git-column.txt
> 
> Since the lines changed by the patch have not been touched within that
> timeframe, git-blame assigns those lines to boundary commit 128a96c984
> (Update draft release notes to 1.8.5 for the fifth batch of topics,
> 2013-09-20), which was authored by Junio, which is why he shows up as
> the only "contact".
> 
> If we remove the --since restriction:
> 
>     git blame --porcelain -C -L13,+7 -L23,+7 -L43,+6 \
>         4a189fff51b1^ -- Documentation/git-column.txt
> 
> then the lines are correctly "blamed" to Duy via commit 7e29b8254f
> (Add column layout skeleton and git-column, 2012-04-21).
> 
> The "Limitations" section of the git-contacts documentation says this:
> 
>     Several conditions controlling a person's significance are
>     currently hard-coded, such as minimum participation level (10%),
>     blame date-limiting (5 years), and `-C` level for detecting moved
>     and copied lines (a single `-C`). In the future, these conditions
>     may become configurable.
> 
> So, this sort of potential issue was understood. Felipe's
> git-related[1], from which git-contacts arose, eventually grew the
> ability to tweak these hard-coded values via command-line options. The
> same could be done for git-contacts. Patches are welcome.
> 
> [1]: https://github.com/felipec/git-related
> 

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

* Re: [PATCH 2/3] git-column.1: clarify initial description, provide examples
  2018-09-20 17:47       ` frederik
  2018-09-21  5:32         ` Eric Sunshine
@ 2018-09-21 16:32         ` Junio C Hamano
  2018-09-21 16:48           ` frederik
  1 sibling, 1 reply; 15+ messages in thread
From: Junio C Hamano @ 2018-09-21 16:32 UTC (permalink / raw)
  To: frederik; +Cc: Duy Nguyen, git

frederik@ofb.net writes:

> On Thu, Sep 20, 2018 at 06:23:03PM +0200, Duy Nguyen wrote:
>> On Wed, Sep 19, 2018 at 03:59:58PM -0700, Junio C Hamano wrote:
>> > > @@ -23,7 +26,7 @@ OPTIONS
>> > >  
>> > >  --mode=<mode>::
>> > >  	Specify layout mode. See configuration variable column.ui for option
>> > > -	syntax.
>> > > +	syntax (in git-config(1)).
>> 
>> I think we usually link to other commands with "linkgit", like
>> linkgit:git-config[1]
>> 
>> Other than that, the rest looks good.
>
> Thank you, then do I edit the patch and resubmit as PATCH v2 with the
> message ID and all that?
>
> Frederick

If this is the only change in the whole 3 patches, then I can just
squash in the following to save one round-trip.

 Documentation/git-column.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/git-column.txt b/Documentation/git-column.txt
index 5bbb51068e..763afabb6d 100644
--- a/Documentation/git-column.txt
+++ b/Documentation/git-column.txt
@@ -26,7 +26,7 @@ OPTIONS
 
 --mode=<mode>::
 	Specify layout mode. See configuration variable column.ui for option
-	syntax (in git-config(1)).
+	syntax in linkgit:git-config[1].
 
 --raw-mode=<n>::
 	Same as --mode but take mode encoded as a number. This is mainly used

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

* Re: [PATCH 2/3] git-column.1: clarify initial description, provide examples
  2018-09-21 16:32         ` Junio C Hamano
@ 2018-09-21 16:48           ` frederik
  0 siblings, 0 replies; 15+ messages in thread
From: frederik @ 2018-09-21 16:48 UTC (permalink / raw)
  To: Junio C Hamano; +Cc: Duy Nguyen, git

Thank you Junio, maybe I will have another chance to get practice
sending a v2 patch.

On Fri, Sep 21, 2018 at 09:32:00AM -0700, Junio C Hamano wrote:
> frederik@ofb.net writes:
> 
> > On Thu, Sep 20, 2018 at 06:23:03PM +0200, Duy Nguyen wrote:
> >> On Wed, Sep 19, 2018 at 03:59:58PM -0700, Junio C Hamano wrote:
> >> > > @@ -23,7 +26,7 @@ OPTIONS
> >> > >  
> >> > >  --mode=<mode>::
> >> > >  	Specify layout mode. See configuration variable column.ui for option
> >> > > -	syntax.
> >> > > +	syntax (in git-config(1)).
> >> 
> >> I think we usually link to other commands with "linkgit", like
> >> linkgit:git-config[1]
> >> 
> >> Other than that, the rest looks good.
> >
> > Thank you, then do I edit the patch and resubmit as PATCH v2 with the
> > message ID and all that?
> >
> > Frederick
> 
> If this is the only change in the whole 3 patches, then I can just
> squash in the following to save one round-trip.
> 
>  Documentation/git-column.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/git-column.txt b/Documentation/git-column.txt
> index 5bbb51068e..763afabb6d 100644
> --- a/Documentation/git-column.txt
> +++ b/Documentation/git-column.txt
> @@ -26,7 +26,7 @@ OPTIONS
>  
>  --mode=<mode>::
>  	Specify layout mode. See configuration variable column.ui for option
> -	syntax (in git-config(1)).
> +	syntax in linkgit:git-config[1].
>  
>  --raw-mode=<n>::
>  	Same as --mode but take mode encoded as a number. This is mainly used
> 

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

end of thread, other threads:[~2018-09-21 16:48 UTC | newest]

Thread overview: 15+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2018-09-19 20:12 [PATCH 0/3] some documentation changes from the beginning of the alphabet Frederick Eaton
2018-09-19 20:12 ` [PATCH 1/3] git-archimport.1: specify what kind of Arch we're talking about Frederick Eaton
2018-09-19 22:59   ` Junio C Hamano
2018-09-19 23:13     ` frederik
2018-09-19 20:12 ` [PATCH 2/3] git-column.1: clarify initial description, provide examples Frederick Eaton
2018-09-19 22:59   ` Junio C Hamano
2018-09-20 16:23     ` Duy Nguyen
2018-09-20 17:47       ` frederik
2018-09-21  5:32         ` Eric Sunshine
2018-09-21 16:32         ` Junio C Hamano
2018-09-21 16:48           ` frederik
2018-09-19 20:12 ` [PATCH 3/3] git-describe.1: clarify that "human readable" is also git-readable Frederick Eaton
2018-09-19 22:49 ` [PATCH 0/3] some documentation changes from the beginning of the alphabet Junio C Hamano
2018-09-21  5:18   ` Eric Sunshine
2018-09-21  5:45     ` frederik

Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

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 read-only IMAP folder(s) and NNTP newsgroup(s).