From: Emily Shaffer <emilyshaffer@google.com>
To: Jonathan Tan <jonathantanmy@google.com>
Cc: git@vger.kernel.org
Subject: Re: [PATCH v7 03/17] hook: add list command
Date: Tue, 9 Feb 2021 13:06:35 -0800 [thread overview]
Message-ID: <YCL5W31A0ClF16ug@google.com> (raw)
In-Reply-To: <20210131031011.1016240-1-jonathantanmy@google.com>
On Sat, Jan 30, 2021 at 07:10:11PM -0800, Jonathan Tan wrote:
>
> > Teach 'git hook list <hookname>', which checks the known configs in
> > order to create an ordered list of hooks to run on a given hook event.
> >
> > Multiple commands can be specified for a given hook by providing
> > multiple "hook.<hookname>.command = <path-to-hook>" lines. Hooks will be
> > run in config order. If more properties need to be set on a given hook
> > in the future, commands can also be specified by providing
> > "hook.<hookname>.command = <hookcmd-name>", as well as a "[hookcmd
> > <hookcmd-name>]" subsection; at minimum, this subsection must contain a
> > "hookcmd.<hookcmd-name>.command = <path-to-hook>" line.
>
> I learned later that this isn't true - in patch 6, the commit message
> and one of the tests therein describe being able to skip a previously
> inline command by making a hookcmd section of the same name and just
> specifying "skip = true" there (without any command).
>
> Maybe just delete the "at minimum" part.
Thanks, nice catch. I dropped "at minimum" and s/must/should/. Since I
received feedback during the dogfood internally that there's no
documentation on "hookcmd.<thing>.skip" whatsoever, I'll try to make
a more detailed overview of hookcmd acting as an alias in the
user-facing docs in that commit.
>
> > +static int list(int argc, const char **argv, const char *prefix)
> > {
> > - struct option builtin_hook_options[] = {
> > + struct list_head *head, *pos;
> > + struct hook *item;
>
> You asked for review on nits too so here's one: "item" should be
> declared in the list_for_each block. (That also makes it easier to see
> that we don't need to free it.)
Ok, done.
>
> > diff --git a/hook.c b/hook.c
> > new file mode 100644
> > index 0000000000..937dc768c8
> > --- /dev/null
> > +++ b/hook.c
> > @@ -0,0 +1,115 @@
> > +#include "cache.h"
> > +
> > +#include "hook.h"
> > +#include "config.h"
>
> Usually we put all the includes together without any intervening blank
> lines.
Done.
>
> > +static void append_or_move_hook(struct list_head *head, const char *command)
> > +{
> > + struct list_head *pos = NULL, *tmp = NULL;
> > + struct hook *to_add = NULL;
> > +
> > + /*
> > + * remove the prior entry with this command; we'll replace it at the
> > + * end.
> > + */
> > + list_for_each_safe(pos, tmp, head) {
> > + struct hook *it = list_entry(pos, struct hook, list);
> > + if (!strcmp(it->command.buf, command)) {
> > + list_del(pos);
> > + /* we'll simply move the hook to the end */
> > + to_add = it;
>
> "break" here?
I think it's safe to do so, but I think I left it out in case duplicates
do make it into the list somehow. But if they're always being inserted
via "append_or_move_hook()" that should not be an issue, so I'll add the
break.
In fact, fixing this exposed a bug. Later, I add using 'pos' instead of
'head':
list_add_tail(&to_add->list, pos);
When I'm guaranteed to iterate to the end of the list, that works fine,
because in this implementation the last element of the list has "->next"
set back to "head". But when 'pos' isn't sure to be at the end of the
list, it breaks the list. Whoops.. :)
>
> > + }
> > + }
> > +
> > + if (!to_add) {
> > + /* adding a new hook, not moving an old one */
> > + to_add = xmalloc(sizeof(struct hook));
>
> Style is to write sizeof(*to_add), I think.
Sure.
>
> [snip]
>
> > +struct hook_config_cb
> > +{
> > + struct strbuf *hookname;
>
> struct declarations have "{" not on a line on its own.
Sure, I can change it. Although, 'git grep -E "struct \w+$"' tells me
there are a few other offenders :) But the count (60ish minus
doc/relnotes references) is much lower than 'git grep -E "struct \w+
\{$"' (800+ matches) so I'm definitely doing it wrong :D
>
> Also, "hookname" could just be a char *?
Hrmph. I think my C++ background is showing - to me, calling ".buf"
(which is cheap) a few times is a small price to pay to get length
info and so on for free. "hookname" can come from the user - "git
hook (list|run) repo-special-magic-hook" - so I worry about leaving it as a raw
char* with no size info associated. Am I being too paranoid?
>
> > + struct list_head *list;
> > +};
> > +
> > +static int hook_config_lookup(const char *key, const char *value, void *cb_data)
> > +{
> > + struct hook_config_cb *data = cb_data;
> > + const char *hook_key = data->hookname->buf;
> > + struct list_head *head = data->list;
> > +
> > + if (!strcmp(key, hook_key)) {
> > + const char *command = value;
> > + struct strbuf hookcmd_name = STRBUF_INIT;
> > +
> > + /* Check if a hookcmd with that name exists. */
> > + strbuf_addf(&hookcmd_name, "hookcmd.%s.command", command);
> > + git_config_get_value(hookcmd_name.buf, &command);
>
> So we don't really care whether git_config_get_value returns 0 or 1 as
> long as it doesn't touch "command" if there is no such hookcmd. That
> fits with how git_config_get_value() is documented, so that's great.
> Perhaps better to document as:
>
> If a hookcmd.%s.command config exists, replace the command with the
> value of that config. (If not, do nothing - git_config_get_value() is
> documented to not overwrite the value argument in this case.)
OK. Thanks, done.
>
> > +
> > + if (!command) {
> > + strbuf_release(&hookcmd_name);
> > + BUG("git_config_get_value overwrote a string it shouldn't have");
> > + }
> > +
> > + /*
> > + * TODO: implement an option-getting callback, e.g.
> > + * get configs by pattern hookcmd.$value.*
> > + * for each key+value, do_callback(key, value, cb_data)
> > + */
> > +
> > + append_or_move_hook(head, command);
> > +
> > + strbuf_release(&hookcmd_name);
> > + }
> > +
> > + return 0;
> > +}
> > +
> > +struct list_head* hook_list(const struct strbuf* hookname)
>
> "const char *hookname" should suffice?
>
> Also, search for "* " and replace with " *" where applicable (also in
> the .h file).
See above.
>
> > +{
> > + struct strbuf hook_key = STRBUF_INIT;
> > + struct list_head *hook_head = xmalloc(sizeof(struct list_head));
> > + struct hook_config_cb cb_data = { &hook_key, hook_head };
> > +
> > + INIT_LIST_HEAD(hook_head);
> > +
> > + if (!hookname)
> > + return NULL;
> > +
> > + strbuf_addf(&hook_key, "hook.%s.command", hookname->buf);
> > +
> > + git_config(hook_config_lookup, (void*)&cb_data);
>
> Do we need this void* cast?
Nope. Dropped, thanks.
>
> > +
> > + strbuf_release(&hook_key);
> > + return hook_head;
> > +}
> > diff --git a/hook.h b/hook.h
> > new file mode 100644
> > index 0000000000..8ffc4f14b6
> > --- /dev/null
> > +++ b/hook.h
> > @@ -0,0 +1,26 @@
> > +#include "config.h"
> > +#include "list.h"
> > +#include "strbuf.h"
> > +
> > +struct hook
> > +{
> > + struct list_head list;
> > + /*
> > + * Config file which holds the hook.*.command definition.
> > + * (This has nothing to do with the hookcmd.<name>.* configs.)
> > + */
> > + enum config_scope origin;
> > + /* The literal command to run. */
> > + struct strbuf command;
>
> "char *" would suffice?
Since 'command' comes directly from user input and is executed, I'm
nervous about using a char* instead of a strbuf even more so than for
the hookname.
>
> The tests look fine.
Thanks for the nitpicky review, it was great! :)
- Emily
next prev parent reply other threads:[~2021-02-09 21:47 UTC|newest]
Thread overview: 170+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-05-21 18:54 [PATCH v2 0/4] propose config-based hooks Emily Shaffer
2020-05-21 18:54 ` [PATCH v2 1/4] doc: propose hooks managed by the config Emily Shaffer
2020-05-22 10:13 ` Phillip Wood
2020-06-09 20:26 ` Emily Shaffer
2020-05-21 18:54 ` [PATCH v2 2/4] hook: scaffolding for git-hook subcommand Emily Shaffer
2020-05-21 18:54 ` [PATCH v2 3/4] hook: add list command Emily Shaffer
2020-05-22 10:27 ` Phillip Wood
2020-06-09 21:49 ` Emily Shaffer
2020-08-17 13:36 ` Phillip Wood
2020-05-24 23:00 ` Johannes Schindelin
2020-05-27 23:37 ` Emily Shaffer
2020-05-21 18:54 ` [PATCH v2 4/4] hook: add --porcelain to " Emily Shaffer
2020-05-24 23:00 ` Johannes Schindelin
2020-05-25 0:29 ` Johannes Schindelin
2020-07-28 22:24 ` [PATCH v3 0/6] propose config-based hooks Emily Shaffer
2020-07-28 22:24 ` [PATCH v3 1/6] doc: propose hooks managed by the config Emily Shaffer
2020-07-28 22:24 ` [PATCH v3 2/6] hook: scaffolding for git-hook subcommand Emily Shaffer
2020-07-28 22:24 ` [PATCH v3 3/6] hook: add list command Emily Shaffer
2020-07-28 22:24 ` [PATCH v3 4/6] hook: add --porcelain to " Emily Shaffer
2020-07-28 22:24 ` [RFC PATCH v3 5/6] parse-options: parse into argv_array Emily Shaffer
2020-07-29 19:33 ` Junio C Hamano
2020-07-30 23:41 ` Junio C Hamano
2020-07-28 22:24 ` [RFC PATCH v3 6/6] hook: add 'run' subcommand Emily Shaffer
2020-09-09 0:49 ` [PATCH v4 0/9] propose config-based hooks Emily Shaffer
2020-09-09 0:49 ` [PATCH v4 1/9] doc: propose hooks managed by the config Emily Shaffer
2020-09-23 22:59 ` Jonathan Tan
2020-09-24 21:54 ` Emily Shaffer
2020-10-07 9:23 ` Ævar Arnfjörð Bjarmason
2020-10-22 0:58 ` Emily Shaffer
2020-10-23 19:10 ` Ævar Arnfjörð Bjarmason
2020-10-29 15:38 ` Emily Shaffer
2020-10-29 20:04 ` Ævar Arnfjörð Bjarmason
2020-09-09 0:49 ` [PATCH v4 2/9] hook: scaffolding for git-hook subcommand Emily Shaffer
2020-10-05 23:24 ` Jonathan Nieder
2020-10-06 19:06 ` Emily Shaffer
2020-09-09 0:49 ` [PATCH v4 3/9] hook: add list command Emily Shaffer
2020-09-11 13:27 ` Phillip Wood
2020-09-11 16:51 ` Emily Shaffer
2020-09-23 23:04 ` Jonathan Tan
2020-10-06 20:46 ` Emily Shaffer
2020-09-27 19:23 ` Martin Ågren
2020-10-06 20:20 ` Emily Shaffer
2020-10-05 23:27 ` Jonathan Nieder
2020-09-09 0:49 ` [PATCH v4 4/9] hook: add --porcelain to " Emily Shaffer
2020-09-28 19:29 ` Josh Steadmon
2020-09-09 0:49 ` [PATCH v4 5/9] parse-options: parse into strvec Emily Shaffer
2020-10-05 23:30 ` Jonathan Nieder
2020-10-06 4:49 ` Junio C Hamano
2020-09-09 0:49 ` [PATCH v4 6/9] hook: add 'run' subcommand Emily Shaffer
2020-09-11 13:30 ` Phillip Wood
2020-09-28 19:29 ` Josh Steadmon
2020-10-05 23:39 ` Jonathan Nieder
2020-10-06 22:57 ` Emily Shaffer
2020-09-09 0:49 ` [PATCH v4 7/9] hook: replace run-command.h:find_hook Emily Shaffer
2020-09-09 20:32 ` Junio C Hamano
2020-09-10 19:08 ` Emily Shaffer
2020-09-23 23:20 ` Jonathan Tan
2020-10-05 23:42 ` Jonathan Nieder
2020-09-09 0:49 ` [PATCH v4 8/9] commit: use config-based hooks Emily Shaffer
2020-09-10 13:50 ` Phillip Wood
2020-09-10 22:21 ` Junio C Hamano
2020-09-23 23:47 ` Jonathan Tan
2020-10-05 21:27 ` Emily Shaffer
2020-10-05 23:48 ` Jonathan Nieder
2020-10-06 19:08 ` Emily Shaffer
2020-09-09 0:49 ` [PATCH v4 9/9] run_commit_hook: take strvec instead of varargs Emily Shaffer
2020-09-10 14:16 ` Phillip Wood
2020-09-11 13:20 ` Phillip Wood
2020-09-09 21:04 ` [PATCH v4 0/9] propose config-based hooks Junio C Hamano
2020-10-14 23:24 ` [PATCH v5 0/8] propose config-based hooks (part I) Emily Shaffer
2020-10-14 23:24 ` [PATCH v5 1/8] doc: propose hooks managed by the config Emily Shaffer
2020-10-15 16:31 ` Ævar Arnfjörð Bjarmason
2020-10-16 17:29 ` Junio C Hamano
2020-10-21 23:37 ` Emily Shaffer
2020-10-14 23:24 ` [PATCH v5 2/8] hook: scaffolding for git-hook subcommand Emily Shaffer
2020-10-14 23:24 ` [PATCH v5 3/8] hook: add list command Emily Shaffer
2020-10-14 23:24 ` [PATCH v5 4/8] hook: include hookdir hook in list Emily Shaffer
2020-10-14 23:24 ` [PATCH v5 5/8] hook: implement hookcmd.<name>.skip Emily Shaffer
2020-10-14 23:24 ` [PATCH v5 6/8] parse-options: parse into strvec Emily Shaffer
2020-10-14 23:24 ` [PATCH v5 7/8] hook: add 'run' subcommand Emily Shaffer
2020-10-14 23:24 ` [PATCH v5 8/8] hook: replace find_hook() with hook_exists() Emily Shaffer
2020-12-05 1:45 ` [PATCH v6 00/17] propose config-based hooks (part I) Emily Shaffer
2020-12-05 1:45 ` [PATCH 01/17] doc: propose hooks managed by the config Emily Shaffer
2020-12-05 1:45 ` [PATCH 02/17] hook: scaffolding for git-hook subcommand Emily Shaffer
2020-12-05 1:45 ` [PATCH 03/17] hook: add list command Emily Shaffer
2020-12-05 1:45 ` [PATCH 04/17] hook: include hookdir hook in list Emily Shaffer
2020-12-05 1:45 ` [PATCH 05/17] hook: respect hook.runHookDir Emily Shaffer
2020-12-05 1:45 ` [PATCH 06/17] hook: implement hookcmd.<name>.skip Emily Shaffer
2020-12-05 1:45 ` [PATCH 07/17] parse-options: parse into strvec Emily Shaffer
2020-12-05 1:45 ` [PATCH 08/17] hook: add 'run' subcommand Emily Shaffer
2020-12-11 10:15 ` Phillip Wood
2020-12-15 21:41 ` Emily Shaffer
2020-12-05 1:45 ` [PATCH 09/17] hook: replace find_hook() with hook_exists() Emily Shaffer
2020-12-05 1:46 ` [PATCH 10/17] hook: support passing stdin to hooks Emily Shaffer
2020-12-05 1:46 ` [PATCH 11/17] run-command: allow stdin for run_processes_parallel Emily Shaffer
2020-12-05 1:46 ` [PATCH 12/17] hook: allow parallel hook execution Emily Shaffer
2020-12-05 1:46 ` [PATCH 13/17] hook: allow specifying working directory for hooks Emily Shaffer
2020-12-05 1:46 ` [PATCH 14/17] run-command: add stdin callback for parallelization Emily Shaffer
2020-12-05 1:46 ` [PATCH 15/17] hook: provide stdin by string_list or callback Emily Shaffer
2020-12-08 21:09 ` SZEDER Gábor
2020-12-08 22:11 ` Emily Shaffer
2020-12-05 1:46 ` [PATCH 16/17] run-command: allow capturing of collated output Emily Shaffer
2020-12-05 1:46 ` [PATCH 17/17] hooks: allow callers to capture output Emily Shaffer
2020-12-16 0:34 ` [PATCH v6 00/17] propose config-based hooks (part I) Josh Steadmon
2020-12-16 0:56 ` Junio C Hamano
2020-12-16 20:16 ` Emily Shaffer
2020-12-16 23:32 ` Junio C Hamano
2020-12-18 2:07 ` Emily Shaffer
2020-12-18 5:29 ` Junio C Hamano
2020-12-22 0:02 ` [PATCH v7 " Emily Shaffer
2020-12-22 0:02 ` [PATCH v7 01/17] doc: propose hooks managed by the config Emily Shaffer
2021-01-23 15:38 ` Ævar Arnfjörð Bjarmason
2021-01-29 23:52 ` Emily Shaffer
2021-02-01 22:11 ` Junio C Hamano
2021-03-10 19:30 ` Emily Shaffer
2020-12-22 0:02 ` [PATCH v7 02/17] hook: scaffolding for git-hook subcommand Emily Shaffer
2020-12-22 0:02 ` [PATCH v7 03/17] hook: add list command Emily Shaffer
2021-01-31 3:10 ` Jonathan Tan
2021-02-09 21:06 ` Emily Shaffer [this message]
2020-12-22 0:02 ` [PATCH v7 04/17] hook: include hookdir hook in list Emily Shaffer
2021-01-31 3:20 ` Jonathan Tan
2021-02-09 22:05 ` Emily Shaffer
2020-12-22 0:02 ` [PATCH v7 05/17] hook: respect hook.runHookDir Emily Shaffer
2021-01-31 3:35 ` Jonathan Tan
2021-02-09 22:31 ` Emily Shaffer
2020-12-22 0:02 ` [PATCH v7 06/17] hook: implement hookcmd.<name>.skip Emily Shaffer
2021-01-31 3:40 ` Jonathan Tan
2021-02-09 22:57 ` Emily Shaffer
2020-12-22 0:02 ` [PATCH v7 07/17] parse-options: parse into strvec Emily Shaffer
2020-12-22 0:02 ` [PATCH v7 08/17] hook: add 'run' subcommand Emily Shaffer
2021-01-31 4:22 ` Jonathan Tan
2021-02-11 22:44 ` Emily Shaffer
2020-12-22 0:02 ` [PATCH v7 09/17] hook: replace find_hook() with hook_exists() Emily Shaffer
2021-01-31 4:39 ` Jonathan Tan
2021-02-12 22:15 ` Emily Shaffer
2021-02-18 22:23 ` Emily Shaffer
2020-12-22 0:02 ` [PATCH v7 10/17] hook: support passing stdin to hooks Emily Shaffer
2020-12-22 0:02 ` [PATCH v7 11/17] run-command: allow stdin for run_processes_parallel Emily Shaffer
2021-02-01 5:38 ` Jonathan Tan
2021-02-19 20:23 ` Emily Shaffer
2020-12-22 0:02 ` [PATCH v7 12/17] hook: allow parallel hook execution Emily Shaffer
2021-02-01 6:04 ` Jonathan Tan
2021-02-22 21:46 ` Emily Shaffer
2020-12-22 0:02 ` [PATCH v7 13/17] hook: allow specifying working directory for hooks Emily Shaffer
2020-12-22 0:02 ` [PATCH v7 14/17] run-command: add stdin callback for parallelization Emily Shaffer
2021-02-01 6:51 ` Jonathan Tan
2021-02-22 23:38 ` Emily Shaffer
2021-02-23 19:33 ` Jonathan Tan
2021-03-10 18:24 ` Emily Shaffer
2020-12-22 0:02 ` [PATCH v7 15/17] hook: provide stdin by string_list or callback Emily Shaffer
2021-02-01 7:04 ` Jonathan Tan
2021-02-23 19:52 ` Emily Shaffer
2021-02-25 20:56 ` Jonathan Tan
2021-03-02 1:47 ` Emily Shaffer
2021-03-02 23:33 ` Jonathan Tan
2020-12-22 0:02 ` [PATCH v7 16/17] run-command: allow capturing of collated output Emily Shaffer
2020-12-22 0:02 ` [PATCH v7 17/17] hooks: allow callers to capture output Emily Shaffer
2020-12-22 2:11 ` [PATCH v7 00/17] propose config-based hooks (part I) Junio C Hamano
2020-12-28 18:34 ` Emily Shaffer
2020-12-28 22:50 ` Junio C Hamano
2020-12-28 22:37 ` [PATCH v3 18/17] doc: make git-hook.txt point of truth Emily Shaffer
2020-12-28 22:39 ` Emily Shaffer
2021-01-29 23:59 ` [PATCH v7 00/17] propose config-based hooks (part I) Emily Shaffer
2021-02-16 19:46 ` Josh Steadmon
2021-02-16 22:47 ` Junio C Hamano
2021-02-17 21:21 ` Josh Steadmon
2021-02-17 23:07 ` Junio C Hamano
2021-02-25 19:50 ` Junio C Hamano
2021-03-01 21:51 ` Emily Shaffer
2021-03-01 22:19 ` 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=YCL5W31A0ClF16ug@google.com \
--to=emilyshaffer@google.com \
--cc=git@vger.kernel.org \
--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).