From: Emily Shaffer <emilyshaffer@google.com>
To: Eric Sunshine <sunshine@sunshineco.com>
Cc: Git List <git@vger.kernel.org>
Subject: Re: [RFC PATCH v2 10/13] walken: add unfiltered object walk from HEAD
Date: Thu, 27 Jun 2019 15:31:10 -0700 [thread overview]
Message-ID: <20190627223110.GH245941@google.com> (raw)
In-Reply-To: <CAPig+cR7rHokaTtZcJJg8trJ14xO3hdeWHqLnB4aOnEUak051w@mail.gmail.com>
On Thu, Jun 27, 2019 at 01:37:58AM -0400, Eric Sunshine wrote:
> On Wed, Jun 26, 2019 at 7:51 PM Emily Shaffer <emilyshaffer@google.com> wrote:
> > Provide a demonstration of a revision walk which traverses all types of
> > object, not just commits. This type of revision walk is used for
> > operations such as creating packfiles and performing fetches or clones,
> > so it's useful to teach new developers how it works. For starters, only
> > demonstrate the unfiltered version, as this will make the tutorial
> > easier to follow.
> > [...]
> > Signed-off-by: Emily Shaffer <emilyshaffer@google.com>
> > ---
> > diff --git a/builtin/walken.c b/builtin/walken.c
> > @@ -103,6 +109,65 @@ static int git_walken_config(const char *var, const char *value, void *cb)
> > +static void walken_show_commit(struct commit *cmt, void *buf)
> > +{
> > + commit_count++;
> > +}
> > +
> > +static void walken_show_object(struct object *obj, const char *str, void *buf)
> > +{
> > + switch (obj->type) {
> > + [...]
> > + case OBJ_TAG:
> > + tag_count++;
> > + break;
> > + case OBJ_COMMIT:
> > + die(_("unexpectedly encountered a commit in "
> > + "walken_show_object\n"));
> > + commit_count++;
>
> The "commit_count++" line is not only dead code, but it also confuses
> the reader (or makes the reader think that the author of this code
> doesn't understand C programming). You should drop this line.
Ow, yes. Removed. This is stale (pre-die()).
>
> > + break;
> > + default:
> > + die(_("unexpected object type %s\n"), type_name(obj->type));
> > + break;
>
> Likewise, this "break" (and the one in the OBJ_COMMIT case) are dead
> code which should be dropped to avoid confusing the reader.
Done.
>
> Don't localize the die() message via _() here or in the preceding
> OBJ_COMMIT case.
I'm a little surprised by that. Is it because die() is expected to only
be seen by the developer? It seems like a poor user experience if
someone in non-English locale encounters a bug that Git team didn't
find, and needed to try to translate the English die() string and figure
out if a workaround is possible.
>
> The two die() messages are unnecessarily dissimilar. Try to unify them
> so that they read in the same way.
I'm a little surprised by this too; it seems to me the root cause of
each would be different. In the former case, I'd guess that
traverse_commit_list()'s behavior changed, and in the latter case I'd
guess that a new object type was recently added to the model. Can you
help me understand the motivation for making the messages similar?
(I don't think, though, that I did a good job of indicating either root
cause in the die() messages as they are now.)
>
> > + }
> > +}> @@ -113,15 +178,15 @@ static void walken_commit_walk(struct rev_info *rev)
> > /*
> > - * prepare_revision_walk() gets the final steps ready for a revision
> > + * prepare_revision_walk() gets the final steps ready for a revision
> > * walk. We check the return value for errors.
> > - */
> > + */
> > /*
> > - * Now we can start the real commit walk. get_revision grabs the next
> > + * Now we can start the real commit walk. get_revision grabs the next
> > * revision based on the contents of rev.
> > */
>
> I think these are just correcting whitespace/indentation errors I
> pointed out in an earlier patch (so they are unnecessary noise in this
> patch).
ACK
next prev parent reply other threads:[~2019-06-27 22:31 UTC|newest]
Thread overview: 102+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-06-07 1:07 [PATCH] documentation: add tutorial for revision walking Emily Shaffer
2019-06-07 1:07 ` [RFC PATCH 00/13] example implementation of revwalk tutorial Emily Shaffer
2019-06-07 1:07 ` [RFC PATCH 01/13] walken: add infrastructure for revwalk demo Emily Shaffer
2019-06-07 1:08 ` [RFC PATCH 02/13] walken: add usage to enable -h Emily Shaffer
2019-06-07 1:08 ` [RFC PATCH 03/13] walken: add placeholder to initialize defaults Emily Shaffer
2019-06-07 1:08 ` [RFC PATCH 04/13] walken: add handler to git_config Emily Shaffer
2019-06-07 1:08 ` [RFC PATCH 05/13] walken: configure rev_info and prepare for walk Emily Shaffer
2019-06-07 1:08 ` [RFC PATCH 06/13] walken: perform our basic revision walk Emily Shaffer
2019-06-07 1:08 ` [RFC PATCH 07/13] walken: filter for authors from gmail address Emily Shaffer
2019-06-07 1:08 ` [RFC PATCH 08/13] walken: demonstrate various topographical sorts Emily Shaffer
2019-06-07 1:08 ` [RFC PATCH 09/13] walken: demonstrate reversing a revision walk list Emily Shaffer
2019-06-07 1:08 ` [RFC PATCH 10/13] walken: add unfiltered object walk from HEAD Emily Shaffer
2019-06-07 1:08 ` [RFC PATCH 11/13] walken: add filtered object walk Emily Shaffer
2019-06-07 19:15 ` Jeff Hostetler
2019-06-17 20:30 ` Emily Shaffer
2019-06-07 1:08 ` [RFC PATCH 12/13] walken: count omitted objects Emily Shaffer
2019-06-07 1:08 ` [RFC PATCH 13/13] walken: reverse the object walk order Emily Shaffer
2019-06-07 6:21 ` [PATCH] documentation: add tutorial for revision walking Eric Sunshine
2019-06-10 21:26 ` Junio C Hamano
2019-06-10 21:38 ` Eric Sunshine
2019-06-17 23:19 ` Emily Shaffer
2019-06-19 8:13 ` Eric Sunshine
2019-06-19 23:35 ` Emily Shaffer
2019-06-23 18:54 ` Eric Sunshine
2019-06-10 20:25 ` Junio C Hamano
2019-06-17 23:50 ` Emily Shaffer
2019-06-19 15:17 ` Junio C Hamano
2019-06-20 21:06 ` Emily Shaffer
2019-07-13 0:39 ` Josh Steadmon
2019-07-16 0:06 ` Emily Shaffer
2019-07-16 17:24 ` Junio C Hamano
2019-06-10 20:49 ` Junio C Hamano
2019-06-17 23:33 ` Emily Shaffer
2019-06-26 23:49 ` [PATCH v2] " Emily Shaffer
2019-06-26 23:50 ` [RFC PATCH v2 00/13] example implementation of revwalk tutorial Emily Shaffer
2019-06-26 23:50 ` [RFC PATCH v2 01/13] walken: add infrastructure for revwalk demo Emily Shaffer
2019-06-26 23:50 ` [RFC PATCH v2 02/13] walken: add usage to enable -h Emily Shaffer
2019-06-27 4:47 ` Eric Sunshine
2019-06-27 18:40 ` Emily Shaffer
2019-06-27 4:50 ` Eric Sunshine
2019-06-26 23:50 ` [RFC PATCH v2 03/13] walken: add placeholder to initialize defaults Emily Shaffer
2019-06-26 23:50 ` [RFC PATCH v2 04/13] walken: add handler to git_config Emily Shaffer
2019-06-27 4:54 ` Eric Sunshine
2019-06-27 18:47 ` Emily Shaffer
2019-06-26 23:50 ` [RFC PATCH v2 05/13] walken: configure rev_info and prepare for walk Emily Shaffer
2019-06-27 5:06 ` Eric Sunshine
2019-06-27 18:56 ` Emily Shaffer
2019-06-26 23:50 ` [RFC PATCH v2 06/13] walken: perform our basic revision walk Emily Shaffer
2019-06-27 5:16 ` Eric Sunshine
2019-06-27 20:54 ` Emily Shaffer
2019-06-26 23:50 ` [RFC PATCH v2 07/13] walken: filter for authors from gmail address Emily Shaffer
2019-06-27 5:20 ` Eric Sunshine
2019-06-27 20:58 ` Emily Shaffer
2019-06-26 23:50 ` [RFC PATCH v2 08/13] walken: demonstrate various topographical sorts Emily Shaffer
2019-06-27 5:22 ` Eric Sunshine
2019-06-27 22:12 ` Emily Shaffer
2019-06-26 23:50 ` [RFC PATCH v2 09/13] walken: demonstrate reversing a revision walk list Emily Shaffer
2019-06-27 5:26 ` Eric Sunshine
2019-06-27 22:20 ` Emily Shaffer
2019-06-26 23:50 ` [RFC PATCH v2 10/13] walken: add unfiltered object walk from HEAD Emily Shaffer
2019-06-27 5:37 ` Eric Sunshine
2019-06-27 22:31 ` Emily Shaffer [this message]
2019-06-28 0:48 ` Eric Sunshine
2019-07-01 19:19 ` Emily Shaffer
2019-06-26 23:50 ` [RFC PATCH v2 11/13] walken: add filtered object walk Emily Shaffer
2019-06-27 5:42 ` Eric Sunshine
2019-06-27 22:33 ` Emily Shaffer
2019-06-26 23:50 ` [RFC PATCH v2 12/13] walken: count omitted objects Emily Shaffer
2019-06-27 5:44 ` Eric Sunshine
2019-06-26 23:50 ` [RFC PATCH v2 13/13] walken: reverse the object walk order Emily Shaffer
2019-06-27 22:56 ` [RFC PATCH v2 00/13] example implementation of revwalk tutorial Emily Shaffer
2019-07-01 20:19 ` [PATCH v3] documentation: add tutorial for revision walking Emily Shaffer
2019-07-01 20:20 ` [RFC PATCH v3 00/13] example implementation of revwalk tutorial Emily Shaffer
2019-07-01 20:20 ` [RFC PATCH v3 01/13] walken: add infrastructure for revwalk demo Emily Shaffer
2019-07-01 20:20 ` [RFC PATCH v3 02/13] walken: add usage to enable -h Emily Shaffer
2019-07-01 20:20 ` [RFC PATCH v3 03/13] walken: add placeholder to initialize defaults Emily Shaffer
2019-07-01 20:20 ` [RFC PATCH v3 04/13] walken: add handler to git_config Emily Shaffer
2019-07-01 20:20 ` [RFC PATCH v3 05/13] walken: configure rev_info and prepare for walk Emily Shaffer
2019-07-01 20:20 ` [RFC PATCH v3 06/13] walken: perform our basic revision walk Emily Shaffer
2019-07-01 20:20 ` [RFC PATCH v3 07/13] walken: filter for authors from gmail address Emily Shaffer
2019-07-01 20:20 ` [RFC PATCH v3 08/13] walken: demonstrate various topographical sorts Emily Shaffer
2019-07-01 20:20 ` [RFC PATCH v3 09/13] walken: demonstrate reversing a revision walk list Emily Shaffer
2019-07-01 20:20 ` [RFC PATCH v3 10/13] walken: add unfiltered object walk from HEAD Emily Shaffer
2019-07-01 20:20 ` [RFC PATCH v3 11/13] walken: add filtered object walk Emily Shaffer
2019-07-01 20:20 ` [RFC PATCH v3 12/13] walken: count omitted objects Emily Shaffer
2019-07-01 20:20 ` [RFC PATCH v3 13/13] walken: reverse the object walk order Emily Shaffer
2019-07-25 9:25 ` [RFC PATCH v3 00/13] example implementation of revwalk tutorial Johannes Schindelin
2019-08-06 23:13 ` Emily Shaffer
2019-08-08 19:19 ` Johannes Schindelin
2019-07-24 23:11 ` [PATCH v3] documentation: add tutorial for revision walking Josh Steadmon
2019-07-24 23:32 ` Jonathan Tan
2019-08-06 23:10 ` Emily Shaffer
2019-08-06 23:19 ` [PATCH v4] " Emily Shaffer
2019-08-07 19:19 ` Junio C Hamano
2019-08-14 18:33 ` Emily Shaffer
2019-08-14 19:18 ` Junio C Hamano
2019-10-10 15:19 ` [PATCH v5] documentation: add tutorial for object walking Emily Shaffer
2019-10-11 5:50 ` Junio C Hamano
2019-10-11 23:26 ` Emily Shaffer
2019-10-11 17:50 ` SZEDER Gábor
2019-10-11 23:33 ` Emily Shaffer
2019-10-11 23:55 ` [PATCH v6] " Emily Shaffer
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=20190627223110.GH245941@google.com \
--to=emilyshaffer@google.com \
--cc=git@vger.kernel.org \
--cc=sunshine@sunshineco.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).