From: Heba Waly <heba.waly@gmail.com>
To: Jonathan Tan <jonathantanmy@google.com>
Cc: Heba Waly via GitGitGadget <gitgitgadget@gmail.com>,
Git Mailing List <git@vger.kernel.org>,
Junio C Hamano <gitster@pobox.com>
Subject: Re: [PATCH v2 1/1] add: use advise function to display hints
Date: Wed, 29 Jan 2020 15:04:17 +1300 [thread overview]
Message-ID: <CACg5j25fi0nSMe2nH+iJ184ouk2VsrBWSZmEv-C_PrY8qfq4Sw@mail.gmail.com> (raw)
In-Reply-To: <20200128000047.176372-1-jonathantanmy@google.com>
On Tue, Jan 28, 2020 at 1:00 PM Jonathan Tan <jonathantanmy@google.com> wrote:
>
> > From: Heba Waly <heba.waly@gmail.com>
> >
> > Use the advise function in advice.c to display hints to the users, as
> > it provides a neat and a standard format for hint messages, i.e: the
> > text is colored in yellow and the line starts by the word "hint:".
> >
> > Also this will enable us to control the messages using advice.*
> > configuration variables.
>
> Firstly, sorry for getting back to this so late.
>
> As written, this gives me the impression that advise() is what enables
> us to control the messages using configuration variables, but that's not
> true - that's done by a separate mechanism in advise.c and .h.
> Paraphrasing what Junio wrote [1], the commit message might be better
> written as:
>
> In the "add" command, use the advice API instead of fprintf() for the
> hint shown when nothing was added. Thus, this hint message follows the
> standard hint message format, and its visibility is made configurable.
>
> (Note that I mentioned the "add" command and called it the advice API
> instead of the advise() function.)
>
That makes sense.
> (Feel free to use this or write your own.)
>
> [1] https://lore.kernel.org/git/xmqqpng1eisc.fsf@gitster-ct.c.googlers.com/
>
> > diff --git a/t/t3700-add.sh b/t/t3700-add.sh
> > index c325167b90..a649805369 100755
> > --- a/t/t3700-add.sh
> > +++ b/t/t3700-add.sh
> > @@ -326,7 +326,7 @@ test_expect_success 'git add --dry-run of an existing file output' "
> > cat >expect.err <<\EOF
> > The following paths are ignored by one of your .gitignore files:
> > ignored-file
> > -Use -f if you really want to add them.
> > +hint: Use -f if you really want to add them.
> > EOF
> > cat >expect.out <<\EOF
> > add 'track-this'
>
> Also add a test that checks what happens if advice.addNothing is set.
> (It seems that we generally don't test what happens when advice is
> suppressed. If we consider solely this patch, I'm on the fence of the
> usefulness of this test, but if we plan to refactor the advise()
> function to take care of checking the config variable itself, for
> example, then we will need such a test anyway, so I think we might as
> well include at least one such advice test now.)
I'm tempted to say let's worry about it when refactoring advise(),
maybe then we'll
find a more suitable place for this test. as it'll be advice-related,
not caller-related.
Thanks,
Heba
next prev parent reply other threads:[~2020-01-29 2:09 UTC|newest]
Thread overview: 26+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-01-02 3:04 [PATCH 0/1] [Outreachy] [RFC] add: use advise function to display hints Heba Waly via GitGitGadget
2020-01-02 3:04 ` [PATCH 1/1] " Heba Waly via GitGitGadget
2020-01-02 19:54 ` Junio C Hamano
2020-01-02 22:47 ` Junio C Hamano
2020-01-07 10:54 ` Heba Waly
2020-01-07 16:35 ` Junio C Hamano
2020-01-07 23:32 ` Heba Waly
2020-01-06 23:13 ` Emily Shaffer
2020-01-06 23:18 ` Junio C Hamano
2020-01-07 4:19 ` Heba Waly
2020-01-06 23:07 ` Emily Shaffer
2020-01-06 23:13 ` Junio C Hamano
2020-01-07 23:12 ` [PATCH v2 0/1] [Outreachy] " Heba Waly via GitGitGadget
2020-01-07 23:12 ` [PATCH v2 1/1] " Heba Waly via GitGitGadget
2020-01-27 23:52 ` Emily Shaffer
2020-01-29 1:09 ` Heba Waly
2020-01-28 0:00 ` Jonathan Tan
2020-01-29 2:04 ` Heba Waly [this message]
2020-01-30 1:11 ` [PATCH v3] add: use advice API " Heba Waly via GitGitGadget
2020-01-30 21:59 ` Junio C Hamano
2020-01-31 11:16 ` Heba Waly
2020-02-05 21:18 ` Junio C Hamano
2020-02-05 22:05 ` Heba Waly
2020-02-05 22:18 ` Junio C Hamano
2020-02-05 23:05 ` Heba Waly
2020-02-05 23:18 ` Junio C Hamano
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=CACg5j25fi0nSMe2nH+iJ184ouk2VsrBWSZmEv-C_PrY8qfq4Sw@mail.gmail.com \
--to=heba.waly@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitgitgadget@gmail.com \
--cc=gitster@pobox.com \
--cc=jonathantanmy@google.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).