Skip to contentSkip to conversation

docs: link to gitsubmodules

PATCH Superseded Brandon Williams 4 participants 8 messages Jun 5, 2018 – Jun 21, 2018 Documentation

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 docs: link to gitsubmodules

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

---
 Documentation/config.txt | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
Documentation/config.txt +3 -2
index ab641bf5a..1277731aa 100644
@@ -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
Signature · 1 line
2.17.1.1185.g55be947832-goog
#1 lore raw
Quoted 2 lines · Brandon Williams

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

#2 lore raw
Quoted 8 lines · Ævar Arnfjörð Bjarmason
Quoted 2 lines · Brandon Williams

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

Signature · 1 line
Brandon Williams
Reviewed-by on v1 1/1
#3 lore raw
In reply to Brandon Williams

Hi,

Quoted 13 lines · Brandon Williams

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

---
 Documentation/config.txt | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
Documentation/config.txt +0 -0
index ab641bf5a..1277731aa 100644

Documentation/config.txt submodule.<name>.ignore:: · line 3331

Quoted 6 lines
Documentation/config.txt +2 -1
@@ -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,

Tested using

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

Thanks,
Jonathan

Documentation/config.txt +2 -2
index 1277731aa4..efbd7e5652 100644
@@ -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
#4 lore raw
Quoted 5 lines · Jonathan Nieder
Documentation/config.txt +0 -0
@@ -3327,13 +3327,13 @@ submodule.<name>.ignore::
 submodule.<name>.active::
 	Boolean value indicating if the submodule is of interest to git

Documentation/config.txt submodule.<name>.ignore:: · line 3336

Quoted 10 lines
Documentation/config.txt +2 -2
 	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

Documentation/config.txt +2 -2
index 1277731aa4..340eb1f3c4 100644
@@ -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
#5 lore raw
Quoted 37 lines · Jonathan Nieder
Quoted 5 lines · Jonathan Nieder
Documentation/config.txt +0 -0
@@ -3327,13 +3327,13 @@ submodule.<name>.ignore::
 submodule.<name>.active::
 	Boolean value indicating if the submodule is of interest to git

Documentation/config.txt submodule.<name>.ignore:: · line 3336

Quoted 10 lines
Documentation/config.txt +2 -2
 	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

Documentation/config.txt +1 -1
index 1277731aa4..340eb1f3c4 100644
@@ -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

Documentation/config.txt submodule.<name>.ignore:: · line 3339

Quoted 10 lines
Documentation/config.txt +1 -1
 	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.

Signature · 1 line
Brandon Williams
#6 lore raw

PATCH v2 1/1 docs: link to gitsubmodules

In reply to Brandon Williams

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

---
 Documentation/config.txt | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
Documentation/config.txt +3 -2
index ab641bf5a..340eb1f3c 100644
@@ -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
Signature · 1 line
2.18.0.rc1.244.gcf134e6275-goog
#7 lore raw
Quoted 7 lines · Brandon Williams

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

---
 Documentation/config.txt | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

Thanks.

Quoted 21 lines
Documentation/config.txt +3 -2
index ab641bf5a..340eb1f3c 100644
@@ -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