threads / patch / 48661

patchdocs: link to gitsubmodules

Subject: [PATCH] docs: link to gitsubmodules

## tl;dr

8 messages between Jun 5, 2018 and Jun 21, 2018. Diffs are folded; open one to read it.

replies: 7people: 4as markdown or json

Brandon Williams· Jun 5, 2018, 20:24 UTC · lore

Add a link to gitsubmodules(7) under the `submodule.active` entry in git-config(1).

Signed-off-by: Brandon Williams <bmwill@google.com>
---
 Documentation/config.txt | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

Show changes to Documentation/config.txt +3 −2

diff --git a/Documentation/config.txt b/Documentation/config.txt
index ab641bf5a..1277731aa 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -3327,12 +3327,13 @@ submodule.<name>.ignore::
 submodule.<name>.active::
 	Boolean value indicating if the submodule is of interest to git
 	commands.  This config option takes precedence over the
-	submodule.active config option.
+	submodule.active config option. See linkgit:git-submodule[1] for
+	details.
 
 submodule.active::
 	A repeated field which contains a pathspec used to match against a
 	submodule's path to determine if the submodule is of interest to git
-	commands.
+	commands. See linkgit:git-submodule[1] for details.
 
 submodule.recurse::
 	Specifies if commands recurse into submodules by default. This

-- 
2.17.1.1185.g55be947832-goog

Ævar Arnfjörð Bjarmason· Jun 5, 2018, 20:35 UTC · re: Brandon Williams · lore

Re: [PATCH] docs: link to gitsubmodules

On Tue, Jun 05 2018, Brandon Williams wrote:

> Add a link to gitsubmodules(7) under the `submodule.active` entry in
> git-config(1).

Did you mean to change either the subject or content of this patch? Your subject says gitsubmodules(7), but you link to git-submodule(1).

Brandon Williams· Jun 5, 2018, 20:39 UTC · re: Ævar Arnfjörð Bjarmason · lore

Re: [PATCH] docs: link to gitsubmodules

On 06/05, Ævar Arnfjörð Bjarmason wrote:

Show 8 quoted lines

> 
> On Tue, Jun 05 2018, Brandon Williams wrote:
> 
> > Add a link to gitsubmodules(7) under the `submodule.active` entry in
> > git-config(1).
> 
> Did you mean to change either the subject or content of this patch? Your
> subject says gitsubmodules(7), but you link to git-submodule(1).

Yep I meant for it to be to gitsubmodules(7), turns out I don't know how our documentation is built :)

-- 
Brandon Williams

Jonathan Nieder· Jun 5, 2018, 20:37 UTC · re: Brandon Williams · lore

Re: [PATCH] docs: link to gitsubmodules

Hi,

Brandon Williams wrote:

Show 19 quoted lines

> Add a link to gitsubmodules(7) under the `submodule.active` entry in
> git-config(1).
>
> Signed-off-by: Brandon Williams <bmwill@google.com>
> ---
>  Documentation/config.txt | 5 +++--
>  1 file changed, 3 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/config.txt b/Documentation/config.txt
> index ab641bf5a..1277731aa 100644
> --- a/Documentation/config.txt
> +++ b/Documentation/config.txt
> @@ -3327,12 +3327,13 @@ submodule.<name>.ignore::
>  submodule.<name>.active::
>  	Boolean value indicating if the submodule is of interest to git
>  	commands.  This config option takes precedence over the
> -	submodule.active config option.
> +	submodule.active config option. See linkgit:git-submodule[1] for
> +	details.

This takes the user to gitsubmodules(7), but with a hop to git-submodule(1) along the way there:

	DESCRIPTION
	       Inspects, updates and manages submodules.

	       For more information about submodules, see gitsubmodules(7).

I suppose I'd prefer that it links directly to linkgit:gitsubmodules[7] just because that would steer people toward commands like "git checkout --recurse-submodules" instead of "git submodule init".

With or without that tweak,
Reviewed-by: Jonathan Nieder <jrnieder@gmail.com>

Tested using

	make -C Documentation/ git-config.1
	man Documentation/git-config.1

Thanks, Jonathan

Show changes to diff +2 −2

diff --git i/Documentation/config.txt w/Documentation/config.txt
index 1277731aa4..efbd7e5652 100644
--- i/Documentation/config.txt
+++ w/Documentation/config.txt
@@ -3327,13 +3327,13 @@ submodule.<name>.ignore::
 submodule.<name>.active::
 	Boolean value indicating if the submodule is of interest to git
 	commands.  This config option takes precedence over the
-	submodule.active config option. See linkgit:git-submodule[1] for
+	submodule.active config option. See linkgit:gitsubmodules[7] for
 	details.
 
 submodule.active::
 	A repeated field which contains a pathspec used to match against a
 	submodule's path to determine if the submodule is of interest to git
-	commands. See linkgit:git-submodule[1] for details.
+	commands. See linkgit:gitsubmodule[7] for details.
 
 submodule.recurse::
 	Specifies if commands recurse into submodules by default. This

Jonathan Nieder· Jun 5, 2018, 20:39 UTC · re: Jonathan Nieder · lore

Re: [PATCH] docs: link to gitsubmodules

Jonathan Nieder wrote:

Show 15 quoted lines

> --- i/Documentation/config.txt
> +++ w/Documentation/config.txt
> @@ -3327,13 +3327,13 @@ submodule.<name>.ignore::
>  submodule.<name>.active::
>  	Boolean value indicating if the submodule is of interest to git
>  	commands.  This config option takes precedence over the
> -	submodule.active config option. See linkgit:git-submodule[1] for
> +	submodule.active config option. See linkgit:gitsubmodules[7] for
>  	details.
>  
>  submodule.active::
>  	A repeated field which contains a pathspec used to match against a
>  	submodule's path to determine if the submodule is of interest to git
> -	commands. See linkgit:git-submodule[1] for details.
> +	commands. See linkgit:gitsubmodule[7] for details.

Gah, and I can't spell. This one should have been linkgit:gitsubmodules[7]. Updated diff below. Tested using

	make -C Documentation/ git-config.html gitsubmodules.html
	w3m Documentation/git-config.html

Thanks and sorry for the noise, Jonathan

Show changes to diff +2 −2

diff --git i/Documentation/config.txt w/Documentation/config.txt
index 1277731aa4..340eb1f3c4 100644
--- i/Documentation/config.txt
+++ w/Documentation/config.txt
@@ -3327,13 +3327,13 @@ submodule.<name>.ignore::
 submodule.<name>.active::
 	Boolean value indicating if the submodule is of interest to git
 	commands.  This config option takes precedence over the
-	submodule.active config option. See linkgit:git-submodule[1] for
+	submodule.active config option. See linkgit:gitsubmodules[7] for
 	details.
 
 submodule.active::
 	A repeated field which contains a pathspec used to match against a
 	submodule's path to determine if the submodule is of interest to git
-	commands. See linkgit:git-submodule[1] for details.
+	commands. See linkgit:gitsubmodules[7] for details.
 
 submodule.recurse::
 	Specifies if commands recurse into submodules by default. This

Brandon Williams· Jun 5, 2018, 20:40 UTC · re: Jonathan Nieder · lore

Re: [PATCH] docs: link to gitsubmodules

On 06/05, Jonathan Nieder wrote:

Show 47 quoted lines

> Jonathan Nieder wrote:
> 
> > --- i/Documentation/config.txt
> > +++ w/Documentation/config.txt
> > @@ -3327,13 +3327,13 @@ submodule.<name>.ignore::
> >  submodule.<name>.active::
> >  	Boolean value indicating if the submodule is of interest to git
> >  	commands.  This config option takes precedence over the
> > -	submodule.active config option. See linkgit:git-submodule[1] for
> > +	submodule.active config option. See linkgit:gitsubmodules[7] for
> >  	details.
> >  
> >  submodule.active::
> >  	A repeated field which contains a pathspec used to match against a
> >  	submodule's path to determine if the submodule is of interest to git
> > -	commands. See linkgit:git-submodule[1] for details.
> > +	commands. See linkgit:gitsubmodule[7] for details.
> 
> Gah, and I can't spell.  This one should have been
> linkgit:gitsubmodules[7].  Updated diff below.  Tested using
> 
> 	make -C Documentation/ git-config.html gitsubmodules.html
> 	w3m Documentation/git-config.html
> 
> Thanks and sorry for the noise,
> Jonathan
> 
> diff --git i/Documentation/config.txt w/Documentation/config.txt
> index 1277731aa4..340eb1f3c4 100644
> --- i/Documentation/config.txt
> +++ w/Documentation/config.txt
> @@ -3327,13 +3327,13 @@ submodule.<name>.ignore::
>  submodule.<name>.active::
>  	Boolean value indicating if the submodule is of interest to git
>  	commands.  This config option takes precedence over the
> -	submodule.active config option. See linkgit:git-submodule[1] for
> +	submodule.active config option. See linkgit:gitsubmodules[7] for
>  	details.
>  
>  submodule.active::
>  	A repeated field which contains a pathspec used to match against a
>  	submodule's path to determine if the submodule is of interest to git
> -	commands. See linkgit:git-submodule[1] for details.
> +	commands. See linkgit:gitsubmodules[7] for details.
>  
>  submodule.recurse::
>  	Specifies if commands recurse into submodules by default. This

Yep this is what I meant.

-- 
Brandon Williams

Brandon Williams· Jun 20, 2018, 21:50 UTC · re: Brandon Williams · lore

[PATCH v2] docs: link to gitsubmodules

Add a link to gitsubmodules(7) under the `submodule.active` entry in git-config(1).

Signed-off-by: Brandon Williams <bmwill@google.com>
---
 Documentation/config.txt | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

Show changes to Documentation/config.txt +3 −2

diff --git a/Documentation/config.txt b/Documentation/config.txt
index ab641bf5a..340eb1f3c 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -3327,12 +3327,13 @@ submodule.<name>.ignore::
 submodule.<name>.active::
 	Boolean value indicating if the submodule is of interest to git
 	commands.  This config option takes precedence over the
-	submodule.active config option.
+	submodule.active config option. See linkgit:gitsubmodules[7] for
+	details.
 
 submodule.active::
 	A repeated field which contains a pathspec used to match against a
 	submodule's path to determine if the submodule is of interest to git
-	commands.
+	commands. See linkgit:gitsubmodules[7] for details.
 
 submodule.recurse::
 	Specifies if commands recurse into submodules by default. This

-- 
2.18.0.rc1.244.gcf134e6275-goog

Junio C Hamano· Jun 21, 2018, 20:58 UTC · re: Brandon Williams · lore

Re: [PATCH v2] docs: link to gitsubmodules

Brandon Williams <bmwill@google.com> writes:

Show 7 quoted lines

> Add a link to gitsubmodules(7) under the `submodule.active` entry in
> git-config(1).
>
> Signed-off-by: Brandon Williams <bmwill@google.com>
> ---
>  Documentation/config.txt | 5 +++--
>  1 file changed, 3 insertions(+), 2 deletions(-)

Thanks.

Show 21 quoted lines

>
> diff --git a/Documentation/config.txt b/Documentation/config.txt
> index ab641bf5a..340eb1f3c 100644
> --- a/Documentation/config.txt
> +++ b/Documentation/config.txt
> @@ -3327,12 +3327,13 @@ submodule.<name>.ignore::
>  submodule.<name>.active::
>  	Boolean value indicating if the submodule is of interest to git
>  	commands.  This config option takes precedence over the
> -	submodule.active config option.
> +	submodule.active config option. See linkgit:gitsubmodules[7] for
> +	details.
>  
>  submodule.active::
>  	A repeated field which contains a pathspec used to match against a
>  	submodule's path to determine if the submodule is of interest to git
> -	commands.
> +	commands. See linkgit:gitsubmodules[7] for details.
>  
>  submodule.recurse::
>  	Specifies if commands recurse into submodules by default. This