Subject: Re: [PATCH 3/3] git submodule update should give notice when run without init beforehand

From: Jens Lehmann <[email-masked]>
Date: Mon, 16 Sep 2013 19:06:42 +0200

Am 15.09.2013 19:38, schrieb Tay Ray Chuan:
> When 'update' is run with no path in a repository with uninitialized
> submodules, the program terminates with no output, and zero status code.
> Be more helpful to users by mentioning this.

Hmm, this patch is changing the default behavior, right? I assume the
motivation for this patch is to help people who tend to forget to init
submodules they need to have checked out, which is a good idea. But I
think this should not be enabled by default, as in a lot of use cases
one or more uninitialized submodules are present on purpose. In those
use cases it would be rather nasty to error out on every submodule
update.

After the 'autoinit' configuration (which lets upstream hint that
certain submodules should be initialized on clone) has materialzed we
might want to enable this error for these specific submodules. But in
any case the error message should contain a hint on how you can get
rid of the error in case you know what you are doing ;-).

> This may be controlled by an advice.* option.
>
> Signed-off-by: Tay Ray Chuan <[email-masked]>
> ---
>  Documentation/config.txt    |  5 +++++
>  git-submodule.sh            | 16 ++++++++++++++--
>  t/t7406-submodule-update.sh |  5 ++++-
>  3 files changed, 23 insertions(+), 3 deletions(-)
> 
> diff --git a/Documentation/config.txt b/Documentation/config.txt
> index ec57a15..79313f9 100644
> --- a/Documentation/config.txt
> +++ b/Documentation/config.txt
> @@ -202,6 +202,11 @@ advice.*::
>  	rmHints::
>  		In case of failure in the output of linkgit:git-rm[1],
>  		show directions on how to proceed from the current state.
> +	submoduleUpdateUninit::
> +		When linkgit:git-submodule[1] `update` is run with no `path`
> +		arguments in a repository with uninitialized submodules,
> +		mention that uninitalized submodules are indeed present, and
> +		that they may be initialized with the `--init` option.
>  --
>  
>  core.fileMode::
> diff --git a/git-submodule.sh b/git-submodule.sh
> index 2979197..56f3dc2 100755
> --- a/git-submodule.sh
> +++ b/git-submodule.sh
> @@ -777,6 +777,7 @@ cmd_update()
>  	cloned_modules=
>  	module_list "$@" | {
>  	err=
> +	has_uninit=
>  	while read mode sha1 stage sm_path
>  	do
>  		die_if_unmatched "$mode"
> @@ -807,9 +808,13 @@ cmd_update()
>  		then
>  			# Only mention uninitialized submodules when its
>  			# path have been specified
> -			test "$#" != "0" &&
> -			say "$(eval_gettext "Submodule path '\$displaypath' not initialized
> +			if test "$#" != "0"
> +			then
> +				say "$(eval_gettext "Submodule path '\$displaypath' not initialized
>  Maybe you want to use 'update --init'?")"
> +			else
> +				has_uninit=1
> +			fi
>  			continue
>  		fi
>  
> @@ -940,6 +945,13 @@ Maybe you want to use 'update --init'?")"
>  		IFS=$OIFS
>  		exit 1
>  	fi
> +
> +	if test -n "$has_uninit" \
> +		-a "$(git config --bool --get advice.submoduleUpdateUninit)" != "false"
> +	then
> +		say "$(eval_gettext "Uninitialized submodules were detected;
> +Maybe you want to use 'update --init'?")"
> +	fi
>  	}
>  }
>  
> diff --git a/t/t7406-submodule-update.sh b/t/t7406-submodule-update.sh
> index 00475eb..8dbe410 100755
> --- a/t/t7406-submodule-update.sh
> +++ b/t/t7406-submodule-update.sh
> @@ -76,8 +76,11 @@ test_expect_success 'submodule update <path> warns without init beforehand' '
>  	)
>  '
>  
> -test_expect_success 'submodule update is silent without init beforehand' '
> +test_expect_success 'submodule update warns without init beforehand' '
>  	(cd super2 &&
> +	 test_must_fail git config --get advice.submoduleUpdateUninit &&
> +	 test -n "$(git submodule update)" &&
> +	 git config advice.submoduleUpdateUninit false &&
>  	 test -z "$(git submodule update)"
>  	)
>  '
>