Re: [PATCH] docs: link to gitsubmodules

2018-06-05 Thread Brandon Williams
On 06/05, Jonathan Nieder wrote:
> Jonathan Nieder wrote:
> 
> > --- i/Documentation/config.txt
> > +++ w/Documentation/config.txt
> > @@ -3327,13 +3327,13 @@ submodule..ignore::
> >  submodule..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..ignore::
>  submodule..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


Re: [PATCH] docs: link to gitsubmodules

2018-06-05 Thread Jonathan Nieder
Jonathan Nieder wrote:

> --- i/Documentation/config.txt
> +++ w/Documentation/config.txt
> @@ -3327,13 +3327,13 @@ submodule..ignore::
>  submodule..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..ignore::
 submodule..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


Re: [PATCH] docs: link to gitsubmodules

2018-06-05 Thread Brandon Williams
On 06/05, Ævar Arnfjörð Bjarmason wrote:
> 
> 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


Re: [PATCH] docs: link to gitsubmodules

2018-06-05 Thread Jonathan Nieder
Hi,

Brandon Williams wrote:

> Add a link to gitsubmodules(7) under the `submodule.active` entry in
> git-config(1).
>
> Signed-off-by: Brandon Williams 
> ---
>  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..ignore::
>  submodule..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 

Tested using

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

Thanks,
Jonathan

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..ignore::
 submodule..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


Re: [PATCH] docs: link to gitsubmodules

2018-06-05 Thread Ævar Arnfjörð Bjarmason


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