Git Mailing List Archive mirror
 help / color / mirror / Atom feed
From: Junio C Hamano <>
To: Emily Shaffer <>
Cc: Vinayak Dev <>,
Subject: Re: Documentation/MyFirstObjectWalk: add #include "trace.h" to use trace_printf()
Date: Thu, 29 Jun 2023 19:21:17 -0700	[thread overview]
Message-ID: <xmqqwmzl7krm.fsf@gitster.g> (raw)

Emily Shaffer <> writes:

> ... I do very much
> like the idea of keeping the reference source in contrib/ as a set of
> patches, maybe along with a script to apply them (or a readme with the
> right `git am` invocation), and then checking that they still build.
> Checking that against the contents of the document is trickier,
> though, like you mentioned. Hm.

An approach to avoid two things (i.e. sample source and the code
snippet in the documentation) going out of sync is not to have two
of them in the first place.  If we give up readability of the MFOW
document in its source form, you may be able to arrange the code
snippet to be incorporated by the build test and documentation at
the same time.

      reply	other threads:[~2023-06-30  2:21 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-06-29 16:05 Documentation/MyFirstObjectWalk: add #include "trace.h" to use trace_printf() Vinayak Dev
2023-06-29 16:33 ` Emily Shaffer
2023-06-29 16:35   ` Emily Shaffer
2023-06-29 18:45     ` Vinayak Dev
2023-06-29 23:09       ` Emily Shaffer
2023-06-30  5:48         ` Vinayak Dev
2023-06-30 15:39           ` Vinayak Dev
2023-06-29 19:28   ` Junio C Hamano
2023-06-29 23:06     ` Emily Shaffer
2023-06-30  2:21       ` Junio C Hamano [this message]

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:

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=xmqqwmzl7krm.fsf@gitster.g \ \ \ \ \

* 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.
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).