From: Emily Shaffer <emilyshaffer@google.com>
To: Junio C Hamano <gitster@pobox.com>
Cc: git@vger.kernel.org
Subject: Re: [PATCH] documentation: add tutorial for revision walking
Date: Mon, 17 Jun 2019 16:33:41 -0700 [thread overview]
Message-ID: <20190617233341.GC100487@google.com> (raw)
In-Reply-To: <xmqq7e9tmahm.fsf@gitster-ct.c.googlers.com>
On Mon, Jun 10, 2019 at 01:49:41PM -0700, Junio C Hamano wrote:
> Emily Shaffer <emilyshaffer@google.com> writes:
>
> > +My First Revision Walk
> > +======================
> > +
> > +== What's a Revision Walk?
> > +
> > +The revision walk is a key concept in Git - this is the process that underpins
> > +operations like `git log`, `git blame`, and `git reflog`. Beginning at HEAD, the
> > +list of objects is found by walking parent relationships between objects. The
> > +revision walk can also be usedto determine whether or not a given object is
> > +reachable from the current HEAD pointer.
>
> s/usedto/used to/;
Done.
>
> > +We'll put our fiddling into a new command. For fun, let's name it `git walken`.
> > +Open up a new file `builtin/walken.c` and set up the command handler:
> > +
> > +----
> > +/*
> > + * "git walken"
> > + *
> > + * Part of the "My First Revision Walk" tutorial.
> > + */
> > +
> > +#include <stdio.h>
>
> Bad idea. In the generic part of the codebase, system headers are
> supposed to be supplied by including git-compat-util.h (or cache.h
> or builtin.h, that are common header files that begin by including
> it and are allowed by CodingGuidelines to be used as such).
Done.
>
> > +#include "builtin.h"
> > +
> > +int cmd_walken(int argc, const char **argv, const char *prefix)
> > +{
> > + printf(_("cmd_walken incoming...\n"));
> > + return 0;
> > +}
> > +----
>
> I wonder if it makes sense to use trace instead of printf, as our
> reader has already seen the psuh example for doing the above.
Hmmm. I will think about it and look into the intended use of each. I
hadn't considered using a different logging method.
>
> > +Add usage text and `-h` handling, in order to pass the test suite:
>
> It is not wrong per-se, and it indeed is a very good practice to
> make sure that our subcommands consistently gives usage text and
> short usage. Encouraging them early is a good idea.
>
> But "in order to pass the test suite" invites "eh, the test suite
> does not pass without usage and -h? why?".
>
> Either drop the mention of "the test suite", or perhaps say
> something like
>
> Add usage text and `-h` handling, like all the subcommands
> should consistently do (our test suite will notice and
> complain if you fail to do so).
>
> i.e. the real purpose is consistency and usability; test suite is
> merely an enforcement mechanism.
Yeah, you're right. I'll reword this.
>
> > +----
> > +{ "walken", cmd_walken, RUN_SETUP },
> > +----
> > +
> > +Add it to the `Makefile` near the line for `builtin\worktree.o`:
>
> Backslash intended?
Nope, typo.
Thanks for the comments, Junio.
- Emily
next prev parent reply other threads:[~2019-06-17 23:33 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 [this message]
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
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=20190617233341.GC100487@google.com \
--to=emilyshaffer@google.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.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).