diff options
| author | Emily Shaffer <emilyshaffer@google.com> | 2020-10-16 13:52:31 -0700 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2020-10-16 15:13:11 -0700 |
| commit | f5bcde6c588896cea1cbcab772b5b5a5f6bd3fd1 (patch) | |
| tree | a1c5145efd964fdda68d1b2e8f6280df2facfbbd /Documentation/MyFirstContribution.txt | |
| parent | 47ae905ffb98cc4d4fd90083da6bc8dab55d9ecc (diff) | |
| download | git-f5bcde6c588896cea1cbcab772b5b5a5f6bd3fd1.tar.gz | |
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>
Diffstat (limited to 'Documentation/MyFirstContribution.txt')
| -rw-r--r-- | Documentation/MyFirstContribution.txt | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/Documentation/MyFirstContribution.txt b/Documentation/MyFirstContribution.txt index d85c9b5143..e7c38d68a6 100644 --- a/Documentation/MyFirstContribution.txt +++ b/Documentation/MyFirstContribution.txt @@ -507,6 +507,9 @@ documentation is consistent with other Git and UNIX manpages; this makes life easier for your user, who can skip to the section they know contains the information they need. +NOTE: Before trying to build the docs, make sure you have the package `asciidoc` +installed. + Now that you've written your manpage, you'll need to build it explicitly. We convert your AsciiDoc to troff which is man-readable like so: @@ -522,8 +525,6 @@ $ make -C Documentation/ git-psuh.1 $ man Documentation/git-psuh.1 ---- -NOTE: You may need to install the package `asciidoc` to get this to work. - While this isn't as satisfying as running through `git help`, you can at least check that your help page looks right. |