Re: [PATCH 1/2] MyFirstContribution: clarify asciidoc dependency

From: Junio C Hamano <gitster@pobox.com>
Date: Oct 16, 2020, 21:21 UTC
Message-ID: <xmqqo8l1amtq.fsf@gitster.c.googlers.com>
In-Reply-To: <20201016205232.2546562-2-emilyshaffer@google.com>

Emily Shaffer <emilyshaffer@google.com> writes:

Show 11 quoted lines

> Per IRC:
>
> [19:52] <lkmandy> With respect to the MyFirstContribution tutorial, I
> will like to suggest this - Under the section "Adding Documentation",
> just before the "make all doc" command, it will be really helpful to
> prompt a user to check if they have the asciidoc package installed, if
> they don't, the command should be provided or they can just be pointed
> to install it
>
> So, let's move the note about the dependency to before the build command
> blockquote.

Suggesting asciidoc alone may not be all that helpful, or unless it drags xmlto, docbook and friends as its dependencies, and the details of that depends on distro packaging.

As this is only moving the existing note around in the documentation, it is not making things any worse, so I am OK to take the patch as-is, but if somebody (it is fine if it were done by you, Emily) can double check "apt-get install asciidoc" on a vanilla box does bring in what we need, that would be quite good. FWIW, we write in our top-level INSTALL file that we require asciidox/xmlto toolchain (the latter is needed if you format for manpage, i.e. if you do "git subcmd --help").

Thanks