Skip to content

Commit f5bcde6

Browse files
nasamuffingitster
authored andcommitted
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 47ae905 commit f5bcde6

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

Documentation/MyFirstContribution.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -507,6 +507,9 @@ documentation is consistent with other Git and UNIX manpages; this makes life
507507
easier for your user, who can skip to the section they know contains the
508508
information they need.
509509

510+
NOTE: Before trying to build the docs, make sure you have the package `asciidoc`
511+
installed.
512+
510513
Now that you've written your manpage, you'll need to build it explicitly. We
511514
convert your AsciiDoc to troff which is man-readable like so:
512515

@@ -522,8 +525,6 @@ $ make -C Documentation/ git-psuh.1
522525
$ man Documentation/git-psuh.1
523526
----
524527

525-
NOTE: You may need to install the package `asciidoc` to get this to work.
526-
527528
While this isn't as satisfying as running through `git help`, you can at least
528529
check that your help page looks right.
529530

0 commit comments

Comments
 (0)