Re: Documentation/MyFirstObjectWalk: add #include "trace.h" to use trace_printf()

From: Junio C Hamano <gitster@pobox.com>
Date: Jun 30, 2023, 02:21 UTC
Message-ID: <xmqqwmzl7krm.fsf@gitster.g>
In-Reply-To: <CAJoAoZnaU7WsCpnZY0Pvjg4_GJMZADF0FNC9fNZK56ShX2JO+g@mail.gmail.com>

Emily Shaffer <nasamuffin@google.com> writes:

Show 6 quoted lines

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