diff options
| author | Junio C Hamano <gitster@pobox.com> | 2020-11-02 13:17:46 -0800 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2020-11-02 13:17:47 -0800 |
| commit | c5b2c9a8cbd743218f57db0a4f1db47aa9e99b2b (patch) | |
| tree | a1bd1118c5c4d1b82e57df4413de775f7118070d /Documentation/MyFirstContribution.txt | |
| parent | 596ad33080472653faa03763b1e0f3a6787e25d4 (diff) | |
| parent | f5bcde6c588896cea1cbcab772b5b5a5f6bd3fd1 (diff) | |
| download | git-c5b2c9a8cbd743218f57db0a4f1db47aa9e99b2b.tar.gz | |
Merge branch 'es/tutorial-mention-asciidoc-early'
Doc update.
* es/tutorial-mention-asciidoc-early:
MyFirstContribution: clarify asciidoc dependency
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 492f3998f7..60eed5edcd 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. |