Re: [RFC PATCH] change default for status.submoduleSummary to true
- From
Jacob Keller <jacob.keller@gmail.com>
- Date
- Mar 30, 2017, 01:33 UTC
- Message-ID
- <CA+P7+xodO7=0TQPZPseDPw_Owsdy2jrCUKpP0G_+j-bz51KNVA@mail.gmail.com>
- In-Reply-To
- <20170330012025.22122-1-sbeller@google.com>
On Wed, Mar 29, 2017 at 6:20 PM, Stefan Beller <sbeller@google.com> wrote:
Show 12 quoted lines
> A user complained about the workflow with submodules: >> Re submodules pain, I've seen a lot of people get confused about >> how and when to commit submodule changes. The main thing missing >> in the related UIs is some way to summarize the subproject commit >> diff in a human readable way. Maybe last log message would be better >> than just sha? > > We could advise all the confused users to turn on > status.submoduleSummary. However there is no downside from turning > it on by default apart from a slight change in behavior and bit > longer output of git-status and the help in git-commit. >
Makes sense to me.
Thanks, Jake
Show 49 quoted lines
> Signed-off-by: Stefan Beller <sbeller@google.com>
> ---
>
> Maybe we can merge this early after 2.13, so we have a longer time frame
> in which people may react to this change of a default?
>
> Thanks,
> Stefan
>
> Documentation/config.txt | 2 +-
> builtin/commit.c | 2 ++
> 2 files changed, 3 insertions(+), 1 deletion(-)
>
> diff --git a/Documentation/config.txt b/Documentation/config.txt
> index 1df1965457..34d4735414 100644
> --- a/Documentation/config.txt
> +++ b/Documentation/config.txt
> @@ -2984,7 +2984,7 @@ This variable can be overridden with the -u|--untracked-files option
> of linkgit:git-status[1] and linkgit:git-commit[1].
>
> status.submoduleSummary::
> - Defaults to false.
> + Defaults to true.
> If this is set to a non zero number or true (identical to -1 or an
> unlimited number), the submodule summary will be enabled and a
> summary of commits for modified submodules will be shown (see
> diff --git a/builtin/commit.c b/builtin/commit.c
> index 4e288bc513..833a651013 100644
> --- a/builtin/commit.c
> +++ b/builtin/commit.c
> @@ -1388,6 +1388,7 @@ int cmd_status(int argc, const char **argv, const char *prefix)
>
> s.ignore_submodule_arg = ignore_submodule_arg;
> s.status_format = status_format;
> + s.submodule_summary = -1;
> s.verbose = verbose;
>
> wt_status_collect(&s);
> @@ -1650,6 +1651,7 @@ int cmd_commit(int argc, const char **argv, const char *prefix)
> status_init_config(&s, git_commit_config);
> status_format = STATUS_FORMAT_NONE; /* Ignore status.short */
> s.colopts = 0;
> + s.submodule_summary = -1;
>
> if (get_sha1("HEAD", oid.hash))
> current_head = NULL;
> --
> 2.12.2.511.g2abb8caf66
>