{"thread":{"id":"30499","subject":"[PATCH] document submdule.$name.update=none option for gitmodules","startedAt":"2012-05-10T18:59:04Z","lastAt":"2012-05-14T19:36:54Z","messageCount":4,"participants":["Heiko Voigt","Philip Oakley"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"191338","messageId":"20120510185903.GF76400@book.hvoigt.net","threadId":"30499","inReplyTo":null,"subject":"[PATCH] document submdule.$name.update=none option for gitmodules","fromName":"Heiko Voigt","fromEmail":"hvoigt@hvoigt.net","sentAt":"2012-05-10T18:59:04Z","receivedAt":"2012-05-10T18:59:04Z","isPatch":true,"sender":{"key":"hvoigt@hvoigt.net","avatar":"https://avatars.githubusercontent.com/u/184958?v=4"},"body":"This option was not yet described in the gitmodules documentation. We\nonly described it in the 'git submodule' command documentation but\ngitmodules is the more natural place to look.\n\nA short reference in the 'git submodule' documentation should be\nsufficient since the details can now be found in the documentation to\ngitmodules.\n\nSigned-off-by: Heiko Voigt <hvoigt@hvoigt.net>\n---\n Documentation/git-submodule.txt |    7 ++-----\n Documentation/gitmodules.txt    |    5 ++++-\n 2 files changed, 6 insertions(+), 6 deletions(-)\n\ndiff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt\nindex c243ee5..c83a856 100644\n--- a/Documentation/git-submodule.txt\n+++ b/Documentation/git-submodule.txt\n@@ -140,7 +140,8 @@ update::\n \tcheckout the commit specified in the index of the containing repository.\n \tThis will make the submodules HEAD be detached unless `--rebase` or\n \t`--merge` is specified or the key `submodule.$name.update` is set to\n-\t`rebase`, `merge` or `none`.\n+\t`rebase`, `merge` or `none`. `none` can be overriden by specifying\n+\t`--checkout`.\n +\n If the submodule is not yet initialized, and you just want to use the\n setting as stored in .gitmodules, you can automatically initialize the\n@@ -148,10 +149,6 @@ submodule with the `--init` option.\n +\n If `--recursive` is specified, this command will recurse into the\n registered submodules, and update any nested submodules within.\n-+\n-If the configuration key `submodule.$name.update` is set to `none` the\n-submodule with name `$name` will not be updated by default. This can be\n-overriden by adding `--checkout` to the command.\n \n summary::\n \tShow commit summary between the given commit (defaults to HEAD) and\ndiff --git a/Documentation/gitmodules.txt b/Documentation/gitmodules.txt\nindex 4e1fd52..4effd78 100644\n--- a/Documentation/gitmodules.txt\n+++ b/Documentation/gitmodules.txt\n@@ -41,8 +41,11 @@ submodule.<name>.update::\n \tthe commit specified in the superproject. If 'merge', the commit\n \tspecified in the superproject will be merged into the current branch\n \tin the submodule.\n+\tIf 'none', the submodule with name `$name` will not be updated\n+\tby default.\n+\n \tThis config option is overridden if 'git submodule update' is given\n-\tthe '--merge' or '--rebase' options.\n+\tthe '--merge', '--rebase' or '--checkout' options.\n \n submodule.<name>.fetchRecurseSubmodules::\n \tThis option can be used to control recursive fetching of this\n-- \n1.7.10.rc2.31.gd8c60\n"},{"id":"191352","messageId":"A406C457BFB948FC9843C8F53AD82CDE@PhilipOakley","threadId":"30499","inReplyTo":"20120510185903.GF76400@book.hvoigt.net","subject":"Re: [PATCH] document submdule.$name.update=none option for gitmodules","fromName":"Philip Oakley","fromEmail":"philipoakley@iee.org","sentAt":"2012-05-10T20:30:12Z","receivedAt":"2012-05-10T20:30:12Z","isPatch":true,"sender":{"key":"philipoakley@iee.email","avatar":"https://avatars.githubusercontent.com/u/914343?v=4"},"body":"From: \"Heiko Voigt\" <hvoigt@hvoigt.net> Sent: Thursday, May 10, 2012 7:59 PM\nSubject: [PATCH] document submdule.$name.update=none option for gitmodules\n\n\n> This option was not yet described in the gitmodules documentation. We\n> only described it in the 'git submodule' command documentation but\n> gitmodules is the more natural place to look.\n\nThe gitmodules documentation is only more natural if we tell (link) the reader early in the submodule documentation. A link to \ngitmodules should be provided in the third paragraph of Description where the .gitmodules is introduced.\n\nCurrently the gitmodules link is the last thing mentioned (i.e. 8 PgDn's for me).\n\n>\n> A short reference in the 'git submodule' documentation should be\n> sufficient since the details can now be found in the documentation to\n> gitmodules.\n>\n> Signed-off-by: Heiko Voigt <hvoigt@hvoigt.net>\n> ---\n> Documentation/git-submodule.txt |    7 ++-----\n> Documentation/gitmodules.txt    |    5 ++++-\n> 2 files changed, 6 insertions(+), 6 deletions(-)\n>\n> diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt\n> index c243ee5..c83a856 100644\n> --- a/Documentation/git-submodule.txt\n> +++ b/Documentation/git-submodule.txt\n> @@ -140,7 +140,8 @@ update::\n>  checkout the commit specified in the index of the containing repository.\n>  This will make the submodules HEAD be detached unless `--rebase` or\n>  `--merge` is specified or the key `submodule.$name.update` is set to\n> - `rebase`, `merge` or `none`.\n> + `rebase`, `merge` or `none`. `none` can be overriden by specifying\n> + `--checkout`.\n> +\n> If the submodule is not yet initialized, and you just want to use the\n> setting as stored in .gitmodules, you can automatically initialize the\n> @@ -148,10 +149,6 @@ submodule with the `--init` option.\n> +\n> If `--recursive` is specified, this command will recurse into the\n> registered submodules, and update any nested submodules within.\n> -+\n> -If the configuration key `submodule.$name.update` is set to `none` the\n> -submodule with name `$name` will not be updated by default. This can be\n> -overriden by adding `--checkout` to the command.\n>\n> summary::\n>  Show commit summary between the given commit (defaults to HEAD) and\n> diff --git a/Documentation/gitmodules.txt b/Documentation/gitmodules.txt\n> index 4e1fd52..4effd78 100644\n> --- a/Documentation/gitmodules.txt\n> +++ b/Documentation/gitmodules.txt\n> @@ -41,8 +41,11 @@ submodule.<name>.update::\n>  the commit specified in the superproject. If 'merge', the commit\n>  specified in the superproject will be merged into the current branch\n>  in the submodule.\n> + If 'none', the submodule with name `$name` will not be updated\n> + by default.\n> +\n>  This config option is overridden if 'git submodule update' is given\n> - the '--merge' or '--rebase' options.\n> + the '--merge', '--rebase' or '--checkout' options.\n>\n> submodule.<name>.fetchRecurseSubmodules::\n>  This option can be used to control recursive fetching of this\n> -- \n> 1.7.10.rc2.31.gd8c60\n>\n"},{"id":"191508","messageId":"20120514173207.GC58058@book.hvoigt.net","threadId":"30499","inReplyTo":"A406C457BFB948FC9843C8F53AD82CDE@PhilipOakley","subject":"[PATCH] link to gitmodules page at the beginning of git-submodule documentation","fromName":"Heiko Voigt","fromEmail":"hvoigt@hvoigt.net","sentAt":"2012-05-14T17:32:08Z","receivedAt":"2012-05-14T17:32:08Z","isPatch":true,"sender":{"key":"hvoigt@hvoigt.net","avatar":"https://avatars.githubusercontent.com/u/184958?v=4"},"body":"This way the user does not have to scroll down to the bottom to find\nit.\n\nSigned-off-by: Heiko Voigt <hvoigt@hvoigt.net>\n---\nOn Thu, May 10, 2012 at 09:30:12PM +0100, Philip Oakley wrote:\n> From: \"Heiko Voigt\" <hvoigt@hvoigt.net> Sent: Thursday, May 10, 2012 7:59 PM\n>> This option was not yet described in the gitmodules documentation. We\n>> only described it in the 'git submodule' command documentation but\n>> gitmodules is the more natural place to look.\n>\n> The gitmodules documentation is only more natural if we tell (link) the \n> reader early in the submodule documentation. A link to gitmodules should \n> be provided in the third paragraph of Description where the .gitmodules \n> is introduced.\n>\n> Currently the gitmodules link is the last thing mentioned (i.e. 8 PgDn's for me).\n\nThe gitmodules documentation page describes all the options you can use\nthere so its by definition more natural. Yes I can see that a link to\ngitmodules page could be provided earlier but thats a completely\ndifferent topic independent from my previous patch. Instead of\ncomplaining how about providing a patch next time?\n\nAnyway here we go...\n\n Documentation/git-submodule.txt | 6 +++---\n 1 file changed, 3 insertions(+), 3 deletions(-)\n\ndiff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt\nindex c83a856..9e488c0 100644\n--- a/Documentation/git-submodule.txt\n+++ b/Documentation/git-submodule.txt\n@@ -43,9 +43,9 @@ if you choose to go that route.\n Submodules are composed from a so-called `gitlink` tree entry\n in the main repository that refers to a particular commit object\n within the inner repository that is completely separate.\n-A record in the `.gitmodules` file at the root of the source\n-tree assigns a logical name to the submodule and describes\n-the default URL the submodule shall be cloned from.\n+A record in the `.gitmodules` (see linkgit:gitmodules[5]) file at the\n+root of the source tree assigns a logical name to the submodule and\n+describes the default URL the submodule shall be cloned from.\n The logical name can be used for overriding this URL within your\n local repository configuration (see 'submodule init').\n \n-- \n1.7.10.1.488.ga84c0c8\n"},{"id":"191522","messageId":"82C8AAD86136458991DBC282E95C7AB1@PhilipOakley","threadId":"30499","inReplyTo":"20120514173207.GC58058@book.hvoigt.net","subject":"Re: [PATCH] link to gitmodules page at the beginning of git-submoduledocumentation","fromName":"Philip Oakley","fromEmail":"philipoakley@iee.org","sentAt":"2012-05-14T19:36:54Z","receivedAt":"2012-05-14T19:36:54Z","isPatch":true,"sender":{"key":"philipoakley@iee.email","avatar":"https://avatars.githubusercontent.com/u/914343?v=4"},"body":"From: \"Heiko Voigt\" <hvoigt@hvoigt.net> Sent: Monday, May 14, 2012 6:32 PM\n> This way the user does not have to scroll down to the bottom to find\n> it.\n>\n> Signed-off-by: Heiko Voigt <hvoigt@hvoigt.net>\n> ---\n> On Thu, May 10, 2012 at 09:30:12PM +0100, Philip Oakley wrote:\n>> From: \"Heiko Voigt\" <hvoigt@hvoigt.net> Sent: Thursday, May 10, 2012 7:59 PM\n>>> This option was not yet described in the gitmodules documentation. We\n>>> only described it in the 'git submodule' command documentation but\n>>> gitmodules is the more natural place to look.\n>>\n>> The gitmodules documentation is only more natural if we tell (link) the\n>> reader early in the submodule documentation. A link to gitmodules should\n>> be provided in the third paragraph of Description where the .gitmodules\n>> is introduced.\n>>\n>> Currently the gitmodules link is the last thing mentioned (i.e. 8 PgDn's for me).\n>\n> The gitmodules documentation page describes all the options you can use\n> there so its by definition more natural. Yes I can see that a link to\n> gitmodules page could be provided earlier but thats a completely\n> different topic independent from my previous patch. Instead of\n> complaining how about providing a patch next time?\n\nMy apologies, I was thinking I was avoiding a clash of patches on a common file, rather than seeing the independance you noted. \nThank you for the patch.\n\n>\n> Anyway here we go...\n>\n> Documentation/git-submodule.txt | 6 +++---\n> 1 file changed, 3 insertions(+), 3 deletions(-)\n>\n> diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt\n> index c83a856..9e488c0 100644\n> --- a/Documentation/git-submodule.txt\n> +++ b/Documentation/git-submodule.txt\n> @@ -43,9 +43,9 @@ if you choose to go that route.\n> Submodules are composed from a so-called `gitlink` tree entry\n> in the main repository that refers to a particular commit object\n> within the inner repository that is completely separate.\n> -A record in the `.gitmodules` file at the root of the source\n> -tree assigns a logical name to the submodule and describes\n> -the default URL the submodule shall be cloned from.\n> +A record in the `.gitmodules` (see linkgit:gitmodules[5]) file at the\n> +root of the source tree assigns a logical name to the submodule and\n> +describes the default URL the submodule shall be cloned from.\n> The logical name can be used for overriding this URL within your\n> local repository configuration (see 'submodule init').\n>\n> -- \n> 1.7.10.1.488.ga84c0c8\n>\n>\n>\n> -----\n"}]}