MyFirstContribution: clarify asciidoc dependency
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. Signed-off-by: Emily Shaffer <emilyshaffer@google.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Emily Shaffer committed
Oct 16, 2020 at 13:52 UTC
f5bcde6c588896cea1cbcab772b5b5a5f6bd3fd1
1 file changed
+3
-2
Documentation/MyFirstContribution.txt
+3
-2
@@ -507,6 +507,9 @@ documentation is consistent with other Git and UNIX manpages; this makes life
507
easier for your user, who can skip to the section they know contains the
508
information they need.
509
510
+NOTE: Before trying to build the docs, make sure you have the package `asciidoc`
511
+installed.
512
+
513
Now that you've written your manpage, you'll need to build it explicitly. We
514
convert your AsciiDoc to troff which is man-readable like so:
515
@@ -522,8 +525,6 @@ $ make -C Documentation/ git-psuh.1
525
$ man Documentation/git-psuh.1
526
----
527
525
-NOTE: You may need to install the package `asciidoc` to get this to work.
526
-
528
While this isn't as satisfying as running through `git help`, you can at least
529
check that your help page looks right.
530