diff mbox series

builtin/gc: warn when core.commitGraph is disabled

Message ID 510425b8b17411eb93770026b95c99cc@oschina.cn (mailing list archive)
State New
Headers show
Series builtin/gc: warn when core.commitGraph is disabled | expand

Commit Message

lilinchao@oschina.cn May 10, 2021, 9:43 a.m. UTC
From: Li Linchao <lilinchao@oschina.cn>

Throw warning message when core.commitGraph is disabled in commit-graph
maintenance task.

Signed-off-by: Li Linchao <lilinchao@oschina.cn>
---
 builtin/gc.c | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

Comments

Ævar Arnfjörð Bjarmason May 10, 2021, 11:55 a.m. UTC | #1
On Mon, May 10 2021, lilinchao@oschina.cn wrote:

> From: Li Linchao <lilinchao@oschina.cn>
>
> Throw warning message when core.commitGraph is disabled in commit-graph
> maintenance task.

Won't this cause the gc.log issue noted in
https://lore.kernel.org/git/87r1l27rae.fsf@evledraar.gmail.com/

More importantly, I don't think this UX makes sense. We said we didn't
want it, so why warn about it?

Maybe there are good reasons to, but this commit message / patch doesn't
make the case for it...


> Signed-off-by: Li Linchao <lilinchao@oschina.cn>
> ---
>  builtin/gc.c | 4 +++-
>  1 file changed, 3 insertions(+), 1 deletion(-)
>
> diff --git a/builtin/gc.c b/builtin/gc.c
> index 98a803196b..90684ca3b3 100644
> --- a/builtin/gc.c
> +++ b/builtin/gc.c
> @@ -861,8 +861,10 @@ static int run_write_commit_graph(struct maintenance_run_opts *opts)
>  static int maintenance_task_commit_graph(struct maintenance_run_opts *opts)
>  {
>  	prepare_repo_settings(the_repository);
> -	if (!the_repository->settings.core_commit_graph)
> +	if (!the_repository->settings.core_commit_graph) {
> +		warning(_("skipping commit-graph task because core.commitGraph is disabled"));
>  		return 0;
> +	}
>  
>  	close_object_store(the_repository->objects);
>  	if (run_write_commit_graph(opts)) {
Junio C Hamano May 10, 2021, 6:12 p.m. UTC | #2
lilinchao@oschina.cn writes:

> From: Li Linchao <lilinchao@oschina.cn>
>
> Throw warning message when core.commitGraph is disabled in commit-graph
> maintenance task.

Why?  If I said, with core.commitGraph, that I do not want to have
anything to do with commitGraph, why should I get disturbed with
such a warning message?


> Signed-off-by: Li Linchao <lilinchao@oschina.cn>
> ---
>  builtin/gc.c | 4 +++-
>  1 file changed, 3 insertions(+), 1 deletion(-)
>
> diff --git a/builtin/gc.c b/builtin/gc.c
> index 98a803196b..90684ca3b3 100644
> --- a/builtin/gc.c
> +++ b/builtin/gc.c
> @@ -861,8 +861,10 @@ static int run_write_commit_graph(struct maintenance_run_opts *opts)
>  static int maintenance_task_commit_graph(struct maintenance_run_opts *opts)
>  {
>  	prepare_repo_settings(the_repository);
> -	if (!the_repository->settings.core_commit_graph)
> +	if (!the_repository->settings.core_commit_graph) {
> +		warning(_("skipping commit-graph task because core.commitGraph is disabled"));
>  		return 0;
> +	}
>  
>  	close_object_store(the_repository->objects);
>  	if (run_write_commit_graph(opts)) {
lilinchao@oschina.cn May 13, 2021, 8:17 a.m. UTC | #3
>
>On Mon, May 10 2021, lilinchao@oschina.cn wrote:
>
>> From: Li Linchao <lilinchao@oschina.cn>
>>
>> Throw warning message when core.commitGraph is disabled in commit-graph
>> maintenance task.
>
>Won't this cause the gc.log issue noted in
>https://lore.kernel.org/git/87r1l27rae.fsf@evledraar.gmail.com/
>
>More importantly, I don't think this UX makes sense. We said we didn't
>want it, so why warn about it?
>
>Maybe there are good reasons to, but this commit message / patch doesn't
>make the case for it...
>
Uh, well, maybe I should argue for this patch a bit more.

First this is in git maintenance task, I've read the link you post, and I feel it has nothing to do with maintenance task.

Second I hope the `commit-graph` task can do the same thing with `incremental repack` task that to warn user when the related necessary setting is not yet ready, instead of running quietly, but doing nothing.

Thanks
Ævar Arnfjörð Bjarmason May 13, 2021, 11:24 a.m. UTC | #4
On Thu, May 13 2021, lilinchao@oschina.cn wrote:

>>
>>On Mon, May 10 2021, lilinchao@oschina.cn wrote:
>>
>>> From: Li Linchao <lilinchao@oschina.cn>
>>>
>>> Throw warning message when core.commitGraph is disabled in commit-graph
>>> maintenance task.
>>
>>Won't this cause the gc.log issue noted in
>>https://lore.kernel.org/git/87r1l27rae.fsf@evledraar.gmail.com/
>>
>>More importantly, I don't think this UX makes sense. We said we didn't
>>want it, so why warn about it?
>>
>>Maybe there are good reasons to, but this commit message / patch doesn't
>>make the case for it...
>>
> Uh, well, maybe I should argue for this patch a bit more.

> First this is in git maintenance task, I've read the link you post,
> and I feel it has nothing to do with maintenance task.

Yes, maybe the issue I noted with gc.log being populated because
something wrote to stderr won't happen here. I was just asking if you'd
taken it into account.

> Second I hope the `commit-graph` task can do the same thing with
> `incremental repack` task that to warn user when the related necessary
> setting is not yet ready, instead of running quietly, but doing
> nothing.

I agree that if you ask git to --do-stuff and core.stuff=false then we
should probably emit a warning, "but you disabled stuff!".

In this case though, isn't the entry point just "incremental", we then
check should_write_commit_graph (as an aside, and not new in your
change, shouldn't this "is the config set" be moved there & be the first
thing we check?).

Then we run maintenance_task_commit_graph, where we see that the config
is disabled.

So aren't there users that want incremental maintenance, but have also
disabled core.commitGraph (or writeCommitGraph or whatever), that are
then going to get a warning about something they explicitly disabled?

Or is this warning just for cases where the user has somehow scheduled a
"commit graph" task, with config disabled, and the task can therefore
never do anything useful? I agree that in such a case it probably makes
sense to warn (or just exit non-zero?).

Anyway, I really do mean what I said about the "issue" being that the
commit message needs to "make a case for it". I.e. even as someone who's
hacked on the gc.c code (although not since "maintenance" became a
thing), I honestly don't know if this warning is OK, i.e. are we at the
point where we issue it where the user really wants the commit graph,
but we just have a misconfiguration?

I *suspect* not, and that it's going to be annoying to people who really
don't want the commit-graph, but who run "incremental", but maybe I'm
wrong.

If that is the case maybe there's still a case for saying something, but
that should probably be an advise(), not a warning().

Or the whole thing is fine, I honestly don't know :)
diff mbox series

Patch

diff --git a/builtin/gc.c b/builtin/gc.c
index 98a803196b..90684ca3b3 100644
--- a/builtin/gc.c
+++ b/builtin/gc.c
@@ -861,8 +861,10 @@  static int run_write_commit_graph(struct maintenance_run_opts *opts)
 static int maintenance_task_commit_graph(struct maintenance_run_opts *opts)
 {
 	prepare_repo_settings(the_repository);
-	if (!the_repository->settings.core_commit_graph)
+	if (!the_repository->settings.core_commit_graph) {
+		warning(_("skipping commit-graph task because core.commitGraph is disabled"));
 		return 0;
+	}
 
 	close_object_store(the_repository->objects);
 	if (run_write_commit_graph(opts)) {