Re: [PATCH] docs: link to gitsubmodules

From: Jonathan Nieder <jrnieder@gmail.com>
Date: Jun 5, 2018, 20:37 UTC
Message-ID: <20180605203704.GA9266@aiede.svl.corp.google.com>
In-Reply-To: <20180605202449.28810-1-bmwill@google.com>

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

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