| Message ID | pull.548.git.1581311049547.gitgitgadget@gmail.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | advice: refactor advise API | expand |
On 2/10/2020 12:04 AM, Heba Waly via GitGitGadget wrote: > From: Heba Waly <heba.waly@gmail.com> > > Add a new advise_ng function that can check the visibility of advice > messages before printing. > > Currently it's very easy for the callers to miss checking the > visibility step. Also, it makes more sense for this step to be handled > by the advice library. This makes the advice API much easier and its uses much cleaner. Thanks! > Also change the advise call in tag library from advise() to advise_ng() > to construct an example of the usage of the new API. This is a good example case. > +static const char turn_off_instructions[] = > +N_("\n" > +"Turn this message off by running\n" > +"\"git config %s false\""); I have mixed feelings on the use of these instructions. Perhaps at minimum the addition of these instructions could be left to a separate patch than the creation of advise_ng(). My biggest concern is that this adds unexpected noise to users who want the advice to stay. I'm calling attention to it, because this part isn't a simple refactor like the rest of the patch. If it _does_ stay, then I recommend condensing the message to a single line. For example: Disable this message with "git config %d false" > +void advise_ng(const char *key, const char *advice, ...) > +{ > + int value = 1; > + struct strbuf buf = STRBUF_INIT; > + va_list params; > + const char *cp, *np; > + > + git_config_get_bool(key, &value); > + > + if(value) > + { Style: spacing, and opening braces are on the same line as the if: if (value) { But also, this method would be simpler if the opposite case was an early return: if (!value) return; Then the rest could have one less indentation. > + va_start(params, advice); > + strbuf_vaddf(&buf, advice, params); > + va_end(params); > + > + strbuf_addf(&buf, turn_off_instructions, key); > + > + for (cp = buf.buf; *cp; cp = np) { > + np = strchrnul(cp, '\n'); > + fprintf(stderr, _("%shint: %.*s%s\n"), > + advise_get_color(ADVICE_COLOR_HINT), > + (int)(np - cp), cp, > + advise_get_color(ADVICE_COLOR_RESET)); > + if (*np) > + np++; > + } > + strbuf_release(&buf); This loop looks like it was copied from advise(). Perhaps we could re-use that code better by creating a new vadvise() method that takes a va_list, and have advise() and advise_ng() call it instead? I include a patch at the end of this method that does this conversion. (Feel free to incorporate it into your next version, if you want, but be sure to add your sign-off.) Then, your advise_ng() can call these: vadvise(advice, params); advise(turn_off_instructions, key); removing the need to re-implement the for loop. > diff --git a/t/helper/test-advise.c b/t/helper/test-advise.c > new file mode 100644 > index 0000000000..b6ec90fd18 > --- /dev/null > +++ b/t/helper/test-advise.c > @@ -0,0 +1,15 @@ > +#include "test-tool.h" > +#include "cache.h" > +#include "advice.h" > + > +int cmd__advise_ng(int argc, const char **argv) > +{ > + if (!argv[1] || !argv[2]) > + die("usage: %s <key> <advice>", argv[0]); > + > + setup_git_directory(); > + > + advise_ng(argv[1], argv[2]); > + > + return 0; > +} I definitely tend to recommend more tests than most, but perhaps this unit test is overkill? You demonstrate a good test below using a real Git command, which should be sufficient. If the "turn this message off" part gets removed, then you will still have coverage of your method. It just won't require a test change because it would not modify behavior. > diff --git a/t/t7004-tag.sh b/t/t7004-tag.sh > index 6db92bd3ba..b7c8d41899 100755 > --- a/t/t7004-tag.sh > +++ b/t/t7004-tag.sh > @@ -1726,6 +1726,8 @@ test_expect_success 'recursive tagging should give advice' ' > hint: already a tag. If you meant to tag the object that it points to, use: > hint: | > hint: git tag -f nested annotated-v4.0^{} > + hint: Turn this message off by running > + hint: "git config advice.nestedTag false" > EOF > git tag -m nested nested annotated-v4.0 2>actual && > test_i18ncmp expect actual > > base-commit: c7a62075917b3340f908093f63f1161c44ed1475 Thanks, -Stolee -->8-- From: Derrick Stolee <dstolee@microsoft.com> Date: Mon, 10 Feb 2020 09:33:20 -0500 Subject: [PATCH] advice: extract vadvise() from advise() In preparation for a new advice method, extract a version of advise() that uses an explict 'va_list' parameter. Call it from advise() for a functionally equivalent version. Signed-off-by: Derrick Stolee <dstolee@microsoft.com> --- advice.c | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/advice.c b/advice.c index 249c60dcf3..fd836332da 100644 --- a/advice.c +++ b/advice.c @@ -96,15 +96,12 @@ static struct { { "pushNonFastForward", &advice_push_update_rejected } }; -void advise(const char *advice, ...) +static void vadvise(const char *advice, va_list params) { struct strbuf buf = STRBUF_INIT; - va_list params; const char *cp, *np; - va_start(params, advice); strbuf_vaddf(&buf, advice, params); - va_end(params); for (cp = buf.buf; *cp; cp = np) { np = strchrnul(cp, '\n'); @@ -118,6 +115,14 @@ void advise(const char *advice, ...) strbuf_release(&buf); } +void advise(const char *advice, ...) +{ + va_list params; + va_start(params, advice); + vadvise(advice, params); + va_end(params); +} + int git_default_advice_config(const char *var, const char *value) { const char *k, *slot_name;
Derrick Stolee <stolee@gmail.com> writes: >> +static const char turn_off_instructions[] = >> +N_("\n" >> +"Turn this message off by running\n" >> +"\"git config %s false\""); > > I have mixed feelings on the use of these instructions. Perhaps at > minimum the addition of these instructions could be left to a > separate patch than the creation of advise_ng(). > > My biggest concern is that this adds unexpected noise to users who > want the advice to stay. I'm calling attention to it, because this > part isn't a simple refactor like the rest of the patch. > ... > I definitely tend to recommend more tests than most, but perhaps this > unit test is overkill? You demonstrate a good test below using a real > Git command, which should be sufficient. If the "turn this message off" > part gets removed, then you will still have coverage of your method. > It just won't require a test change because it would not modify behavior. > ... All good suggestions. Thanks for an excellent review. Another thing. advise_ng() may have been a good name for illustration but is a horrible name for real-world use (imagine we need to revamp the API one more time in the future---what would it be called, which has to say that it is newer than the "next generation"? advise_3rd_try()?). Thanks.
On Mon, Feb 10, 2020 at 11:30:46AM -0800, Junio C Hamano wrote: > Derrick Stolee <stolee@gmail.com> writes: > > >> +static const char turn_off_instructions[] = > >> +N_("\n" > >> +"Turn this message off by running\n" > >> +"\"git config %s false\""); > > > > I have mixed feelings on the use of these instructions. Perhaps at > > minimum the addition of these instructions could be left to a > > separate patch than the creation of advise_ng(). > > > > My biggest concern is that this adds unexpected noise to users who > > want the advice to stay. I'm calling attention to it, because this > > part isn't a simple refactor like the rest of the patch. > > ... > > I definitely tend to recommend more tests than most, but perhaps this > > unit test is overkill? You demonstrate a good test below using a real > > Git command, which should be sufficient. If the "turn this message off" > > part gets removed, then you will still have coverage of your method. > > It just won't require a test change because it would not modify behavior. > > ... > > All good suggestions. Thanks for an excellent review. > > Another thing. > > advise_ng() may have been a good name for illustration but is a > horrible name for real-world use (imagine we need to revamp the API > one more time in the future---what would it be called, which has to > say that it is newer than the "next generation"? > advise_3rd_try()?). What about calling this new API 'advise()'? The first patch could call it 'advise_ng' or whatever other temporary name we feel comfortable using, and then each subsequent patch would update callers of 'advise()' to use 'advise_ng()'. Once those patches have been applied, and no other callers of 'advise()' exist, a final patch can be applied on top to rename 'advise_ng()' to 'advise()', and update the names of all of the callers. This makes for a rather noisy final patch, but the intermediate states are much clearer, and it would make this series rather self-contained. On the other hand, having a version of 'advise_ng()' on master makes this topic more incremental, meaning that we can pick it up and put it down at ease and have more self-contained projects. I don't really have a preference between the two approaches, but if we go with the latter, I do think we need something better than 'advise_ng'. Maybe 'advise_warn'? I don't know. > Thanks. Thanks, Taylor
On Mon, Feb 10, 2020 at 05:04:09AM +0000, Heba Waly via GitGitGadget wrote: > The advice API is currently a little bit confusing to call. quoting from > [1]: > > When introducing a new advice message, you would > > * come up with advice.frotz configuration variable > > * define and declare advice_frotz global variable that defaults to > true > > * sprinkle calls like this: > > if (advice_frotz) > advise(_("helpful message about frotz")); > > A new approach was suggested in [1] which this patch is based upon. I agree that the current procedure is a bit painful, and I think this is a step in the right direction. But... > After this patch the plan is to migrate the rest of the advise calls to > advise_ng and then finally remove advise() and rename advise_ng() to > advise() ...this step may not be possible, for a few reasons: 1. Some of the sites do more than just advise(). E.g., branch.c checks the flag and calls both error() and advise(). 2. Some callers may have to do work to generate the arguments. If I have: advise("advice.foo", "some data: %s", generate_data()); then we'll call generate_data() even if we'll throw away the result in the end. Similarly, some users of advice_* variables do not call advise() at all (some call die(), some like builtin/rm.c stuff the result in a strbuf, and I don't even know what's going on with wt_status.hints. :) So I think you may need to phase it in a bit more, like: a. introduce want_advice() which decides whether or not to show the advice based on a config key. I'd also suggest making the "advice." part of the key implicit, just to make life easier for the callers. b. introduce advise_key() which uses want_advice() and advise() under the hood to do what your advise_ng() is doing here. c. convert simple patterns of: if (advice_foo) advise("bar"); into: advise_key("foo", "bar"); and drop advice_foo where possible. d. handle more complex cases one-by-one. For example, with something like: if (advice_foo) die("bar"); we probably want: if (want_advice("foo")) die("bar"); instead. Using string literals is more accident-prone than variables (because the compiler doesn't notice if we misspell them) but I think is OK for cases where we just refer to the key once. For others (e.g., advice_commit_before_merge has 13 mentions), either keep the variable. Or alternatively make a wrapper like: int want_advice_commit_before_merge(void) { return want_advice("commitbeforemerge"); } if we want to drop the existing mechanism to load all of the variables at the beginning. -Peff
On Mon, Feb 10, 2020 at 11:42:53AM -0800, Taylor Blau wrote: > On Mon, Feb 10, 2020 at 11:30:46AM -0800, Junio C Hamano wrote: > > Derrick Stolee <stolee@gmail.com> writes: > > > > >> +static const char turn_off_instructions[] = > > >> +N_("\n" > > >> +"Turn this message off by running\n" > > >> +"\"git config %s false\""); > > > > > > I have mixed feelings on the use of these instructions. Perhaps at > > > minimum the addition of these instructions could be left to a > > > separate patch than the creation of advise_ng(). > > > > > > My biggest concern is that this adds unexpected noise to users who > > > want the advice to stay. I'm calling attention to it, because this > > > part isn't a simple refactor like the rest of the patch. > > > ... > > > I definitely tend to recommend more tests than most, but perhaps this > > > unit test is overkill? You demonstrate a good test below using a real > > > Git command, which should be sufficient. If the "turn this message off" > > > part gets removed, then you will still have coverage of your method. > > > It just won't require a test change because it would not modify behavior. > > > ... > > > > All good suggestions. Thanks for an excellent review. > > > > Another thing. > > > > advise_ng() may have been a good name for illustration but is a > > horrible name for real-world use (imagine we need to revamp the API > > one more time in the future---what would it be called, which has to > > say that it is newer than the "next generation"? > > advise_3rd_try()?). > > What about calling this new API 'advise()'? The first patch could call > it 'advise_ng' or whatever other temporary name we feel comfortable > using, and then each subsequent patch would update callers of 'advise()' > to use 'advise_ng()'. Once those patches have been applied, and no other > callers of 'advise()' exist, a final patch can be applied on top to > rename 'advise_ng()' to 'advise()', and update the names of all of the > callers. I think this is the precise strategy called out in the patch description. https://lore.kernel.org/git/pull.548.git.1581311049547.gitgitgadget@gmail.com > This makes for a rather noisy final patch, but the intermediate states > are much clearer, and it would make this series rather self-contained. > > On the other hand, having a version of 'advise_ng()' on master makes > this topic more incremental, meaning that we can pick it up and put it > down at ease and have more self-contained projects. > > I don't really have a preference between the two approaches, but if we > go with the latter, I do think we need something better than > 'advise_ng'. Maybe 'advise_warn'? I don't know. I like that this opens up the possibility of advise_err(), advise_die(), whatever to meet Peff's suggestion. - Emily
"Heba Waly via GitGitGadget" <gitgitgadget@gmail.com> writes: > A new advise_ng() is introduced to gradually replace advise() > > pros of the new advise(): > > * The caller doesn't need to define a new global variable when > introducing a new message. > * The caller doesn't need to check the visibility of the message before > calling advise_ng(). > * The caller still needs to come up with advice.frotz config variable > and will call advice_ng as follows: advice_ng("advice.frotz", > _("helpful message about frotz")); Readers would expect to see "cons of the same" to follow "pros". > After this patch the plan is to migrate the rest of the advise calls to > advise_ng and then finally remove advise() and rename advise_ng() to > advise() As I outlined in [1], I think the over-simplified "advise_ng(<advise.key>, _(<message>), ...)" would be too limited to replace the current users, without a pair of helper functions, one to just check for the guarding advise.key, and the other to unconditionally show the message (i.e. the latter is what the current advise() is). > [1] > https://public-inbox.org/git/xmqqzhf5cw69.fsf@gitster-ct.c.googlers.com/
On Mon, Feb 10, 2020 at 03:37:25PM -0500, Jeff King wrote: > On Mon, Feb 10, 2020 at 05:04:09AM +0000, Heba Waly via GitGitGadget wrote: > > > The advice API is currently a little bit confusing to call. quoting from > > [1]: > > > > When introducing a new advice message, you would > > > > * come up with advice.frotz configuration variable > > > > * define and declare advice_frotz global variable that defaults to > > true > > > > * sprinkle calls like this: > > > > if (advice_frotz) > > advise(_("helpful message about frotz")); > > > > A new approach was suggested in [1] which this patch is based upon. > > I agree that the current procedure is a bit painful, and I think this is > a step in the right direction. But... > > > After this patch the plan is to migrate the rest of the advise calls to > > advise_ng and then finally remove advise() and rename advise_ng() to > > advise() > > ...this step may not be possible, for a few reasons: > > 1. Some of the sites do more than just advise(). E.g., branch.c checks > the flag and calls both error() and advise(). > > 2. Some callers may have to do work to generate the arguments. If I > have: > > advise("advice.foo", "some data: %s", generate_data()); > > then we'll call generate_data() even if we'll throw away the result > in the end. > > Similarly, some users of advice_* variables do not call advise() at all > (some call die(), some like builtin/rm.c stuff the result in a strbuf, > and I don't even know what's going on with wt_status.hints. :) > > So I think you may need to phase it in a bit more, like: > > a. introduce want_advice() which decides whether or not to show the > advice based on a config key. I'd also suggest making the "advice." > part of the key implicit, just to make life easier for the callers. > > b. introduce advise_key() which uses want_advice() and advise() under > the hood to do what your advise_ng() is doing here. > > c. convert simple patterns of: > > if (advice_foo) > advise("bar"); > > into: > > advise_key("foo", "bar"); > > and drop advice_foo where possible. > > d. handle more complex cases one-by-one. For example, with something > like: > > if (advice_foo) > die("bar"); > > we probably want: > > if (want_advice("foo")) > die("bar"); > > instead. Using string literals is more accident-prone than > variables (because the compiler doesn't notice if we misspell them) > but I think is OK for cases where we just refer to the key once. > For others (e.g., advice_commit_before_merge has 13 mentions), > either keep the variable. Or alternatively make a wrapper like: > > int want_advice_commit_before_merge(void) > { > return want_advice("commitbeforemerge"); > } > > if we want to drop the existing mechanism to load all of the > variables at the beginning. I tend to disagree on both counts. I'd personally rather see something like 'void advise_key(enum advice, char *format, ...)'. As I understand it, Heba wanted to avoid that pattern so that people adding a new advice didn't need to modify the advice library. However, I think there's value to having a centralized list of all possible advices (besides the documentation). The per-advice wrapper is harder to iterate than an enum, and will also result in a lot of samey code if we decide we want to use that pattern for more advices. (In fact, with git-bugreport I'm running into a lot of regret that hooks are invoked in the way Peff describes - 'find_hook("pre-commit")' - rather than with an enum naming the hook; it's very hard to check all possible hooks, and hard to examine the codebase and determine which hooks do and don't exist.) When Heba began to describe this project I had hoped for a final product like 'void show_advice(enum advice_config)' which looked up the appropriate string from the advice library instead of asking the caller to provide it, although seeing the need for varargs has demonstrated to me that that's not feasible :) But I think taking the advice config key as an argument is possibly too far the other direction. At that point, it starts to beg the question, "why isn't this function in config.h and called print_if_configured(cfgname, message, ...)?" Although, take this all with a grain of salt. I think I lean towards this much encapsulation after a sordid history with C++ and an enlightened C developer may not choose it ;) - Emily
On Tue, Feb 11, 2020 at 3:38 AM Derrick Stolee <stolee@gmail.com> wrote: > > On 2/10/2020 12:04 AM, Heba Waly via GitGitGadget wrote: > > From: Heba Waly <heba.waly@gmail.com> > > > > Add a new advise_ng function that can check the visibility of advice > > messages before printing. > > > > Currently it's very easy for the callers to miss checking the > > visibility step. Also, it makes more sense for this step to be handled > > by the advice library. > > This makes the advice API much easier and its uses much cleaner. Thanks! > > > Also change the advise call in tag library from advise() to advise_ng() > > to construct an example of the usage of the new API. > > This is a good example case. > > > +static const char turn_off_instructions[] = > > +N_("\n" > > +"Turn this message off by running\n" > > +"\"git config %s false\""); > > I have mixed feelings on the use of these instructions. Perhaps at > minimum the addition of these instructions could be left to a > separate patch than the creation of advise_ng(). > > My biggest concern is that this adds unexpected noise to users who > want the advice to stay. I'm calling attention to it, because this > part isn't a simple refactor like the rest of the patch. > > If it _does_ stay, then I recommend condensing the message to > a single line. For example: > > Disable this message with "git config %d false" > I agree with you, I had mixed feelings about it too when suggested on a previous patch [2]. But then I realized that it's hard for the user to find the right config variable to turn off from the doc only. So I like the compromise of condensing it to a single line. > > + if(value) > > + { > > Style: spacing, and opening braces are on the same line as the if: > > if (value) { > > But also, this method would be simpler if the opposite case was > an early return: > > if (!value) > return; > Then the rest could have one less indentation. Agree > This loop looks like it was copied from advise(). Perhaps we could > re-use that code better by creating a new vadvise() method that > takes a va_list, and have advise() and advise_ng() call it instead? > I include a patch at the end of this method that does this conversion. > (Feel free to incorporate it into your next version, if you want, but > be sure to add your sign-off.) Then, your advise_ng() can call these: > > vadvise(advice, params); > advise(turn_off_instructions, key); > > removing the need to re-implement the for loop. My intention was to replace advise() by advise_ng(), so I didn't mind a temp code repetition during the transition phase. But as it seems like some folks would rather keep both, then yes of course a vadvise() function is the way to go, thanks. > > diff --git a/t/helper/test-advise.c b/t/helper/test-advise.c > > new file mode 100644 > > index 0000000000..b6ec90fd18 > > --- /dev/null > > +++ b/t/helper/test-advise.c > > @@ -0,0 +1,15 @@ > > +#include "test-tool.h" > > +#include "cache.h" > > +#include "advice.h" > > + > > +int cmd__advise_ng(int argc, const char **argv) > > +{ > > + if (!argv[1] || !argv[2]) > > + die("usage: %s <key> <advice>", argv[0]); > > + > > + setup_git_directory(); > > + > > + advise_ng(argv[1], argv[2]); > > + > > + return 0; > > +} > > I definitely tend to recommend more tests than most, but perhaps this > unit test is overkill? You demonstrate a good test below using a real > Git command, which should be sufficient. If the "turn this message off" > part gets removed, then you will still have coverage of your method. > It just won't require a test change because it would not modify behavior. > I see your point but I wanted to make sure advise_ng honors the config variable using tests 2 & 3 in `t0018-advice.sh` and `t7004-tag.sh` didn't seem like a good place to add these tests. > > diff --git a/t/t7004-tag.sh b/t/t7004-tag.sh > > index 6db92bd3ba..b7c8d41899 100755 > > --- a/t/t7004-tag.sh > > +++ b/t/t7004-tag.sh > > @@ -1726,6 +1726,8 @@ test_expect_success 'recursive tagging should give advice' ' > > hint: already a tag. If you meant to tag the object that it points to, use: > > hint: | > > hint: git tag -f nested annotated-v4.0^{} > > + hint: Turn this message off by running > > + hint: "git config advice.nestedTag false" > > EOF > > git tag -m nested nested annotated-v4.0 2>actual && > > test_i18ncmp expect actual > > > > base-commit: c7a62075917b3340f908093f63f1161c44ed1475 > > Thanks, > -Stolee > > -->8-- > > From: Derrick Stolee <dstolee@microsoft.com> > Date: Mon, 10 Feb 2020 09:33:20 -0500 > Subject: [PATCH] advice: extract vadvise() from advise() > > In preparation for a new advice method, extract a version of advise() > that uses an explict 'va_list' parameter. Call it from advise() for a > functionally equivalent version. > > Signed-off-by: Derrick Stolee <dstolee@microsoft.com> > --- > advice.c | 13 +++++++++---- > 1 file changed, 9 insertions(+), 4 deletions(-) > > diff --git a/advice.c b/advice.c > index 249c60dcf3..fd836332da 100644 > --- a/advice.c > +++ b/advice.c > @@ -96,15 +96,12 @@ static struct { > { "pushNonFastForward", &advice_push_update_rejected } > }; > > -void advise(const char *advice, ...) > +static void vadvise(const char *advice, va_list params) > { > struct strbuf buf = STRBUF_INIT; > - va_list params; > const char *cp, *np; > > - va_start(params, advice); > strbuf_vaddf(&buf, advice, params); > - va_end(params); > > for (cp = buf.buf; *cp; cp = np) { > np = strchrnul(cp, '\n'); > @@ -118,6 +115,14 @@ void advise(const char *advice, ...) > strbuf_release(&buf); > } > > +void advise(const char *advice, ...) > +{ > + va_list params; > + va_start(params, advice); > + vadvise(advice, params); > + va_end(params); > +} > + > int git_default_advice_config(const char *var, const char *value) > { > const char *k, *slot_name; > -- > 2.25.0.vfs.1.1.1.g9906319d24.dirty > > > [2] https://lore.kernel.org/git/CACg5j26DEXuxwqRYHi5UOBUpRwsu_2A9LwgyKq4qB9wxqasD7g@mail.gmail.com/
On Tue, Feb 11, 2020 at 8:42 AM Taylor Blau <me@ttaylorr.com> wrote: > > On Mon, Feb 10, 2020 at 11:30:46AM -0800, Junio C Hamano wrote: > > Another thing. > > > > advise_ng() may have been a good name for illustration but is a > > horrible name for real-world use (imagine we need to revamp the API > > one more time in the future---what would it be called, which has to > > say that it is newer than the "next generation"? > > advise_3rd_try()?). As I mentioned earlier, this patch is meant to be used as a transition between the current advise() and the refactored one. So the name is just temporary and it'll be renamed to advise() once the transition is done. But if we want to keep both functions, or want a better name because it's an open-source project and the author might not complete the transition, then I'll try to think of another name. > What about calling this new API 'advise()'? The first patch could call > it 'advise_ng' or whatever other temporary name we feel comfortable > using, and then each subsequent patch would update callers of 'advise()' > to use 'advise_ng()'. Once those patches have been applied, and no other > callers of 'advise()' exist, a final patch can be applied on top to > rename 'advise_ng()' to 'advise()', and update the names of all of the > callers. > Yes, that's what I would like to do. > This makes for a rather noisy final patch, but the intermediate states > are much clearer, and it would make this series rather self-contained. > > On the other hand, having a version of 'advise_ng()' on master makes > this topic more incremental, meaning that we can pick it up and put it > down at ease and have more self-contained projects. > > I don't really have a preference between the two approaches, but if we > go with the latter, I do think we need something better than > 'advise_ng'. Maybe 'advise_warn'? I don't know. > > > Thanks. > > Thanks, > Taylor Thanks, Heba
On Tue, Feb 11, 2020 at 11:46 AM Junio C Hamano <gitster@pobox.com> wrote: > > > As I outlined in [1], I think the over-simplified > "advise_ng(<advise.key>, _(<message>), ...)" would be too limited > to replace the current users, without a pair of helper functions, > one to just check for the guarding advise.key, and the other to > unconditionally show the message (i.e. the latter is what the > current advise() is). > I agree with adding the first helper, specially after Peff's comments, but I don't see why we would keep the current advise() which unconditionally shows the message... As far as I understand from a previous discussion [3], that's a wrong usage that we need to avoid, quoting from [3]: ``` If there are many other places that calls to advise() are made without getting guarded by the toggles defined in advice.c, we should fix them, I think. ``` > > [1] > > https://public-inbox.org/git/xmqqzhf5cw69.fsf@gitster-ct.c.googlers.com/ [3] https://public-inbox.org/git/xmqqpng1eisc.fsf@gitster-ct.c.googlers.com/
On Tue, Feb 11, 2020 at 9:37 AM Jeff King <peff@peff.net> wrote: > > On Mon, Feb 10, 2020 at 05:04:09AM +0000, Heba Waly via GitGitGadget wrote: > > > The advice API is currently a little bit confusing to call. quoting from > > [1]: > > > > When introducing a new advice message, you would > > > > * come up with advice.frotz configuration variable > > > > * define and declare advice_frotz global variable that defaults to > > true > > > > * sprinkle calls like this: > > > > if (advice_frotz) > > advise(_("helpful message about frotz")); > > > > A new approach was suggested in [1] which this patch is based upon. > > I agree that the current procedure is a bit painful, and I think this is > a step in the right direction. But... > > > After this patch the plan is to migrate the rest of the advise calls to > > advise_ng and then finally remove advise() and rename advise_ng() to > > advise() > > ...this step may not be possible, for a few reasons: > > 1. Some of the sites do more than just advise(). E.g., branch.c checks > the flag and calls both error() and advise(). > > 2. Some callers may have to do work to generate the arguments. If I > have: > > advise("advice.foo", "some data: %s", generate_data()); > > then we'll call generate_data() even if we'll throw away the result > in the end. > > Similarly, some users of advice_* variables do not call advise() at all > (some call die(), some like builtin/rm.c stuff the result in a strbuf, > and I don't even know what's going on with wt_status.hints. :) > > So I think you may need to phase it in a bit more, like: > > a. introduce want_advice() which decides whether or not to show the > advice based on a config key. I'd also suggest making the "advice." > part of the key implicit, just to make life easier for the callers. > yes, I agree. > b. introduce advise_key() which uses want_advice() and advise() under > the hood to do what your advise_ng() is doing here. > > c. convert simple patterns of: > > if (advice_foo) > advise("bar"); > > into: > > advise_key("foo", "bar"); > > and drop advice_foo where possible. > > d. handle more complex cases one-by-one. For example, with something > like: > > if (advice_foo) > die("bar"); > > we probably want: > > if (want_advice("foo")) > die("bar"); > > instead. Using string literals is more accident-prone than > variables (because the compiler doesn't notice if we misspell them) > but I think is OK for cases where we just refer to the key once. > For others (e.g., advice_commit_before_merge has 13 mentions), > either keep the variable. Or alternatively make a wrapper like: > > int want_advice_commit_before_merge(void) > { > return want_advice("commitbeforemerge"); > } > > if we want to drop the existing mechanism to load all of the > variables at the beginning. > All make sense to me, thanks for the feedback. > -Peff Heba
On Tue, Feb 11, 2020 at 11:55 AM Emily Shaffer <emilyshaffer@google.com> wrote: > > On Mon, Feb 10, 2020 at 03:37:25PM -0500, Jeff King wrote: > > > > instead. Using string literals is more accident-prone than > > variables (because the compiler doesn't notice if we misspell them) > > but I think is OK for cases where we just refer to the key once. > > For others (e.g., advice_commit_before_merge has 13 mentions), > > either keep the variable. Or alternatively make a wrapper like: > > > > int want_advice_commit_before_merge(void) > > { > > return want_advice("commitbeforemerge"); > > } > > > > if we want to drop the existing mechanism to load all of the > > variables at the beginning. > > I tend to disagree on both counts. I'd personally rather see something > like 'void advise_key(enum advice, char *format, ...)'. > > As I understand it, Heba wanted to avoid that pattern so that people > adding a new advice didn't need to modify the advice library. However, I > think there's value to having a centralized list of all possible advices > (besides the documentation). The per-advice wrapper is harder to iterate > than an enum, and will also result in a lot of samey code if we decide > we want to use that pattern for more advices. > I think Peff is suggesting the wrapper for only those rare cases where a single advice config variable is being checked several times around the code base, but this doesn't mean we'll have many of them. In my own opinion, I don't see the need for the list of advices, I think it'll add unneeded complexity to the advice library and the introduction of new advice messages. Mainly because I don't see a scenario where we'd need to iterate through them, so I don't know ... > (In fact, with git-bugreport I'm running into a lot of regret that hooks > are invoked in the way Peff describes - 'find_hook("pre-commit")' - > rather than with an enum naming the hook; it's very hard to check all > possible hooks, and hard to examine the codebase and determine which > hooks do and don't exist.) > > When Heba began to describe this project I had hoped for a final product > like 'void show_advice(enum advice_config)' which looked up the > appropriate string from the advice library instead of asking the caller > to provide it, although seeing the need for varargs has demonstrated to > me that that's not feasible :) But I think taking the advice config key > as an argument is possibly too far the other direction. At that point, > it starts to beg the question, "why isn't this function in config.h and > called print_if_configured(cfgname, message, ...)?" > > Although, take this all with a grain of salt. I think I lean towards > this much encapsulation after a sordid history with C++ and an > enlightened C developer may not choose it ;) > > - Emily
On 2/10/2020 6:56 PM, Heba Waly wrote: > On Tue, Feb 11, 2020 at 3:38 AM Derrick Stolee <stolee@gmail.com> wrote: >> >> I definitely tend to recommend more tests than most, but perhaps this >> unit test is overkill? You demonstrate a good test below using a real >> Git command, which should be sufficient. If the "turn this message off" >> part gets removed, then you will still have coverage of your method. >> It just won't require a test change because it would not modify behavior. >> > > I see your point but I wanted to make sure advise_ng honors the config > variable using tests 2 & 3 in `t0018-advice.sh` > and `t7004-tag.sh` didn't seem like a good place to add these tests. You're right. I wasn't considering the case of not showing the message with respect to the config. -Stolee
Heba Waly <heba.waly@gmail.com> writes: > On Tue, Feb 11, 2020 at 11:46 AM Junio C Hamano <gitster@pobox.com> wrote: >> >> >> As I outlined in [1], I think the over-simplified >> "advise_ng(<advise.key>, _(<message>), ...)" would be too limited >> to replace the current users, without a pair of helper functions, >> one to just check for the guarding advise.key, and the other to >> unconditionally show the message (i.e. the latter is what the >> current advise() is). >> > > I agree with adding the first helper, specially after Peff's comments, > but I don't see why we would keep the current advise() which > unconditionally shows the message... Look again at the message you referenced in your message that started this round, and read its comment: if (advise_ng_enabled("frotz")) { char *result = expensive_computation(...); /* * advise_ng("frotz", _("message %s about frotz", result)); * is fine as well, but slightly less efficient as * it would involve another call to *_enabled(), so use * the unconditional form of the call */ advise_ng_raw(_("message %s about frotz", result)); free(result); }
On Mon, Feb 10, 2020 at 02:55:28PM -0800, Emily Shaffer wrote: > I tend to disagree on both counts. I'd personally rather see something > like 'void advise_key(enum advice, char *format, ...)'. Yeah, I don't mind that at all. It's mutually exclusive with not making people add new enums when they want to add new advice types, but as you note we do get some code maintenance benefit by having the variables, even if _adding_ a new one is a slightly larger pain. -Peff
On Tue, Feb 11, 2020 at 02:49:43PM -0500, Jeff King wrote: > On Mon, Feb 10, 2020 at 02:55:28PM -0800, Emily Shaffer wrote: > > > I tend to disagree on both counts. I'd personally rather see something > > like 'void advise_key(enum advice, char *format, ...)'. > > Yeah, I don't mind that at all. It's mutually exclusive with not making > people add new enums when they want to add new advice types, but as you > note we do get some code maintenance benefit by having the variables, > even if _adding_ a new one is a slightly larger pain. Thinking on it a bit more, one argument in favor of having enums or variables or whatever is that we _do_ need a master list of all of the variables in one spot: the documentation. So one direction we _could_ go is either generating the enum from the documentation or vice versa (or generating both from a master list). That would give us one place to define a new key along with its description. -Peff
On Tue, Feb 11, 2020 at 01:08:48PM +1300, Heba Waly wrote: > On Tue, Feb 11, 2020 at 8:42 AM Taylor Blau <me@ttaylorr.com> wrote: > > > > On Mon, Feb 10, 2020 at 11:30:46AM -0800, Junio C Hamano wrote: > > > Another thing. > > > > > > advise_ng() may have been a good name for illustration but is a > > > horrible name for real-world use (imagine we need to revamp the API > > > one more time in the future---what would it be called, which has to > > > say that it is newer than the "next generation"? > > > advise_3rd_try()?). > > As I mentioned earlier, this patch is meant to be used as a transition > between the current advise() and the refactored one. Ah, thanks for pointing it out, and I'm sorry that I missed reading it in my first review. Your idea sounds quite good to me, and thanks for working on this. > So the name is just temporary and it'll be renamed to advise() once > the transition is done. > But if we want to keep both functions, or want a better name because > it's an open-source project and the author might not complete the > transition, then I'll try to think of another name. > > > What about calling this new API 'advise()'? The first patch could call > > it 'advise_ng' or whatever other temporary name we feel comfortable > > using, and then each subsequent patch would update callers of 'advise()' > > to use 'advise_ng()'. Once those patches have been applied, and no other > > callers of 'advise()' exist, a final patch can be applied on top to > > rename 'advise_ng()' to 'advise()', and update the names of all of the > > callers. > > > > Yes, that's what I would like to do. > > > This makes for a rather noisy final patch, but the intermediate states > > are much clearer, and it would make this series rather self-contained. > > > > On the other hand, having a version of 'advise_ng()' on master makes > > this topic more incremental, meaning that we can pick it up and put it > > down at ease and have more self-contained projects. > > > > I don't really have a preference between the two approaches, but if we > > go with the latter, I do think we need something better than > > 'advise_ng'. Maybe 'advise_warn'? I don't know. > > > > > Thanks. > > > > Thanks, > > Taylor > > Thanks, > Heba Thanks, Taylor
diff --git a/Makefile b/Makefile index 09f98b777c..ed923a3e81 100644 --- a/Makefile +++ b/Makefile @@ -695,6 +695,7 @@ X = PROGRAMS += $(patsubst %.o,git-%$X,$(PROGRAM_OBJS)) +TEST_BUILTINS_OBJS += test-advise.o TEST_BUILTINS_OBJS += test-chmtime.o TEST_BUILTINS_OBJS += test-config.o TEST_BUILTINS_OBJS += test-ctype.o diff --git a/advice.c b/advice.c index 249c60dcf3..4793e59223 100644 --- a/advice.c +++ b/advice.c @@ -29,7 +29,6 @@ int advice_ignored_hook = 1; int advice_waiting_for_editor = 1; int advice_graft_file_deprecated = 1; int advice_checkout_ambiguous_remote_branch_name = 1; -int advice_nested_tag = 1; int advice_submodule_alternate_error_strategy_die = 1; static int advice_use_color = -1; @@ -89,7 +88,6 @@ static struct { { "waitingForEditor", &advice_waiting_for_editor }, { "graftFileDeprecated", &advice_graft_file_deprecated }, { "checkoutAmbiguousRemoteBranchName", &advice_checkout_ambiguous_remote_branch_name }, - { "nestedTag", &advice_nested_tag }, { "submoduleAlternateErrorStrategyDie", &advice_submodule_alternate_error_strategy_die }, /* make this an alias for backward compatibility */ @@ -118,6 +116,41 @@ void advise(const char *advice, ...) strbuf_release(&buf); } +static const char turn_off_instructions[] = +N_("\n" +"Turn this message off by running\n" +"\"git config %s false\""); + +void advise_ng(const char *key, const char *advice, ...) +{ + int value = 1; + struct strbuf buf = STRBUF_INIT; + va_list params; + const char *cp, *np; + + git_config_get_bool(key, &value); + + if(value) + { + va_start(params, advice); + strbuf_vaddf(&buf, advice, params); + va_end(params); + + strbuf_addf(&buf, turn_off_instructions, key); + + for (cp = buf.buf; *cp; cp = np) { + np = strchrnul(cp, '\n'); + fprintf(stderr, _("%shint: %.*s%s\n"), + advise_get_color(ADVICE_COLOR_HINT), + (int)(np - cp), cp, + advise_get_color(ADVICE_COLOR_RESET)); + if (*np) + np++; + } + strbuf_release(&buf); + } +} + int git_default_advice_config(const char *var, const char *value) { const char *k, *slot_name; diff --git a/advice.h b/advice.h index b706780614..ad4da2d65d 100644 --- a/advice.h +++ b/advice.h @@ -29,12 +29,16 @@ extern int advice_ignored_hook; extern int advice_waiting_for_editor; extern int advice_graft_file_deprecated; extern int advice_checkout_ambiguous_remote_branch_name; -extern int advice_nested_tag; extern int advice_submodule_alternate_error_strategy_die; int git_default_advice_config(const char *var, const char *value); __attribute__((format (printf, 1, 2))) void advise(const char *advice, ...); + +/** + Checks the visibility of the advice before priniting. + */ +void advise_ng(const char *key, const char *advice, ...); int error_resolve_conflict(const char *me); void NORETURN die_resolve_conflict(const char *me); void NORETURN die_conclude_merge(void); diff --git a/builtin/tag.c b/builtin/tag.c index e0a4c25382..7fe1ff3ed0 100644 --- a/builtin/tag.c +++ b/builtin/tag.c @@ -231,8 +231,8 @@ static void create_tag(const struct object_id *object, const char *object_ref, if (type <= OBJ_NONE) die(_("bad object type.")); - if (type == OBJ_TAG && advice_nested_tag) - advise(_(message_advice_nested_tag), tag, object_ref); + if (type == OBJ_TAG) + advise_ng("advice.nestedTag", _(message_advice_nested_tag), tag, object_ref); strbuf_addf(&header, "object %s\n" diff --git a/t/helper/test-advise.c b/t/helper/test-advise.c new file mode 100644 index 0000000000..b6ec90fd18 --- /dev/null +++ b/t/helper/test-advise.c @@ -0,0 +1,15 @@ +#include "test-tool.h" +#include "cache.h" +#include "advice.h" + +int cmd__advise_ng(int argc, const char **argv) +{ + if (!argv[1] || !argv[2]) + die("usage: %s <key> <advice>", argv[0]); + + setup_git_directory(); + + advise_ng(argv[1], argv[2]); + + return 0; +} diff --git a/t/helper/test-tool.c b/t/helper/test-tool.c index f20989d449..f903f32bb6 100644 --- a/t/helper/test-tool.c +++ b/t/helper/test-tool.c @@ -14,6 +14,7 @@ struct test_cmd { }; static struct test_cmd cmds[] = { + { "advise", cmd__advise_ng }, { "chmtime", cmd__chmtime }, { "config", cmd__config }, { "ctype", cmd__ctype }, diff --git a/t/helper/test-tool.h b/t/helper/test-tool.h index 8ed2af71d1..e5e955beb9 100644 --- a/t/helper/test-tool.h +++ b/t/helper/test-tool.h @@ -4,6 +4,7 @@ #define USE_THE_INDEX_COMPATIBILITY_MACROS #include "git-compat-util.h" +int cmd__advise_ng(int argc, const char **argv); int cmd__chmtime(int argc, const char **argv); int cmd__config(int argc, const char **argv); int cmd__ctype(int argc, const char **argv); diff --git a/t/t0018-advice.sh b/t/t0018-advice.sh new file mode 100755 index 0000000000..d012db515d --- /dev/null +++ b/t/t0018-advice.sh @@ -0,0 +1,29 @@ +#!/bin/sh + +test_description='Test advise_ng functionality' + +. ./test-lib.sh + +cat > expected <<EOF +hint: This is a piece of advice +hint: Turn this message off by running +hint: "git config advice.configVariable false" +EOF +test_expect_success 'advise should be printed when config variable is unset' ' + test-tool advise "advice.configVariable" "This is a piece of advice" 2>actual && + test_i18ncmp expected actual +' + +test_expect_success 'advise should be printed when config variable is set to true' ' + test_config advice.configVariable true && + test-tool advise "advice.configVariable" "This is a piece of advice" 2>actual && + test_i18ncmp expected actual +' + +test_expect_success 'advise should not be printed when config variable is set to false' ' + test_config advice.configVariable false && + test-tool advise "advice.configVariable" "This is a piece of advice" 2>actual && + test_must_be_empty actual +' + +test_done diff --git a/t/t7004-tag.sh b/t/t7004-tag.sh index 6db92bd3ba..b7c8d41899 100755 --- a/t/t7004-tag.sh +++ b/t/t7004-tag.sh @@ -1726,6 +1726,8 @@ test_expect_success 'recursive tagging should give advice' ' hint: already a tag. If you meant to tag the object that it points to, use: hint: | hint: git tag -f nested annotated-v4.0^{} + hint: Turn this message off by running + hint: "git config advice.nestedTag false" EOF git tag -m nested nested annotated-v4.0 2>actual && test_i18ncmp expect actual