From: Johannes Schindelin <Johannes.Schindelin@gmx.de>
To: Emily Shaffer <emilyshaffer@google.com>
Cc: git@vger.kernel.org
Subject: Re: [RFC PATCH v3 00/13] example implementation of revwalk tutorial
Date: Thu, 8 Aug 2019 21:19:18 +0200 (CEST) [thread overview]
Message-ID: <nycvar.QRO.7.76.6.1908082118130.46@tvgsbejvaqbjf.bet> (raw)
In-Reply-To: <20190806231328.GB130824@google.com>
Hi Emily,
On Tue, 6 Aug 2019, Emily Shaffer wrote:
> On Thu, Jul 25, 2019 at 11:25:02AM +0200, Johannes Schindelin wrote:
> >
> > On Mon, 1 Jul 2019, Emily Shaffer wrote:
> >
> > > Since v2, mostly reworded comments, plus fixed the issues mentioned in
> > > the tutorial itself. Thanks Eric for the review.
> > >
> > > Emily Shaffer (13):
> > > walken: add infrastructure for revwalk demo
> > > walken: add usage to enable -h
> > > walken: add placeholder to initialize defaults
> > > walken: add handler to git_config
> > > walken: configure rev_info and prepare for walk
> > > walken: perform our basic revision walk
> > > walken: filter for authors from gmail address
> > > walken: demonstrate various topographical sorts
> > > walken: demonstrate reversing a revision walk list
> > > walken: add unfiltered object walk from HEAD
> > > walken: add filtered object walk
> > > walken: count omitted objects
> > > walken: reverse the object walk order
> > >
> > > Makefile | 1 +
> > > builtin.h | 1 +
> > > builtin/walken.c | 297 +++++++++++++++++++++++++++++++++++++++++++++++
> >
> > Since this is not really intended to be an end user-facing command, I
> > think it should not become a built-in, to be carried into every Git
> > user's setup.
>
> It's not intended to be checked into Git source as-is.
Then it runs the very real danger of becoming stale: we do _not_
guarantee a stable API, not even an internal one.
> > Instead, I would recommend to implement this as a test helper.
>
> I'm not sure I follow how you imagine this looking, but the drawback I
> see of implementing this in a different way than you would typically do
> when writing a real feature for the project is that it becomes less
> useful as a reference for new contributors.
To the contrary. Some code in `t/helper/` is intended to test
functionality in a way that is copy-editable.
Your use case strikes me a perfect example for such a test helper:
- It guarantees that the example is valid,
- It demonstrates how to use the API,
- In case the API changes, the changes to the helper will inform
contributors how to change their copy-edited versions
> > This would have the following advantages:
> >
> > - it won't clutter the end user installations,
> >
> > - it will still be compile-tested with every build (guaranteeing that
> > the tutorial won't become stale over time as so many other tutorials),
>
> This part of your suggestion appeals to me; so I'm really curious how
> you would do it. Do you have something else written in the way you're
> suggesting in mind?
I looked at `t/helper/test-hashmap.c` and it looks _almost_ like a
perfect example for what I have in mind: it uses a given API,
demonstrates how to use it properly, and is copy-editable.
Ciao,
Dscho
next prev parent reply other threads:[~2019-08-08 19:19 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
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 [this message]
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=nycvar.QRO.7.76.6.1908082118130.46@tvgsbejvaqbjf.bet \
--to=johannes.schindelin@gmx.de \
--cc=emilyshaffer@google.com \
--cc=git@vger.kernel.org \
/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).