[PATCH v2 1/3] add: use advise_if_enabled for ADVICE_ADD_IGNORED_FILE
- From
Rubén Justo <rjusto@gmail.com>
- Date
- Mar 30, 2024, 14:07 UTC
- Message-ID
- <57bbf2a2-1596-4b7c-a467-82b7b5b22a20@gmail.com>
- In-Reply-To
- <46fba030-d7aa-49d2-88fa-e506850f7b6a@gmail.com>
Since b3b18d1621 (advice: revamp advise API, 2020-03-02), we can use advise_if_enabled() to display an advice. This API encapsulates three actions: 1.- checking the visibility of the advice
2.- displaying the advice when appropriate
3.- displaying instructions on how to disable the advice, when appropriate
The code we have in builtin/add.c to display the ADVICE_ADD_IGNORED_FILE advice, is doing these three things. However, the instructions displayed on how to disable the hint are not shown in the normalized way that advise_if_enabled() introduced. This may cause distraction.
There is no reason not to use the new API here. On the contrary, by using it we gain simplicity in the code and avoid possible distractions.
For these reasons, use the newer advise_if_enabled() machinery to show the ADVICE_ADD_IGNORED_FILE advice, and don't bother checking the visibility or displaying the instruction on how to disable the advice.
Signed-off-by: Rubén Justo <rjusto@gmail.com> --- builtin/add.c | 6 ++---- t/t3700-add.sh | 3 +-- t/t7400-submodule-basic.sh | 3 +-- 3 files changed, 4 insertions(+), 8 deletions(-)
diff --git a/builtin/add.c b/builtin/add.c index 393c10cbcf..8f148987f7 100644 --- a/builtin/add.c +++ b/builtin/add.c @@ -328,10 +328,8 @@ static int add_files(struct dir_struct *dir, int flags) fprintf(stderr, _(ignore_error)); for (i = 0; i < dir->ignored_nr; i++) fprintf(stderr, "%s\n", dir->ignored[i]->name); - if (advice_enabled(ADVICE_ADD_IGNORED_FILE)) - advise(_("Use -f if you really want to add them.\n" - "Turn this message off by running\n" - "\"git config advice.addIgnoredFile false\"")); + advise_if_enabled(ADVICE_ADD_IGNORED_FILE, + _("Use -f if you really want to add them.")); exit_status = 1; } diff --git a/t/t3700-add.sh b/t/t3700-add.sh index f23d39f0d5..76c2c9e7b0 100755 --- a/t/t3700-add.sh +++ b/t/t3700-add.sh @@ -370,8 +370,7 @@ cat >expect.err <<\EOF The following paths are ignored by one of your .gitignore files: ignored-file hint: Use -f if you really want to add them. -hint: Turn this message off by running -hint: "git config advice.addIgnoredFile false" +hint: Disable this message with "git config advice.addIgnoredFile false" EOF cat >expect.out <<\EOF add 'track-this' diff --git a/t/t7400-submodule-basic.sh b/t/t7400-submodule-basic.sh index 00c1f1aab1..5c4a89df5c 100755 --- a/t/t7400-submodule-basic.sh +++ b/t/t7400-submodule-basic.sh @@ -212,8 +212,7 @@ test_expect_success 'submodule add to .gitignored path fails' ' The following paths are ignored by one of your .gitignore files: submod hint: Use -f if you really want to add them. - hint: Turn this message off by running - hint: "git config advice.addIgnoredFile false" + hint: Disable this message with "git config advice.addIgnoredFile false" EOF # Does not use test_commit due to the ignore echo "*" > .gitignore &&
-- 2.44.0.417.g254ece0ee4