Browse Source

Merge branch 'doc_deps_local_rep' of https://github.com/ingwinlu/erlang.mk

Loïc Hoguin 9 years ago
parent
commit
ac9a8b4753

+ 7 - 0
doc/src/guide/asciidoc.asciidoc

@@ -5,6 +5,13 @@ Erlang.mk provides rules for generating documentation from
 AsciiDoc files. It can automatically build a user guide PDF,
 AsciiDoc files. It can automatically build a user guide PDF,
 chunked HTML documentation and Unix manual pages.
 chunked HTML documentation and Unix manual pages.
 
 
+=== Requirements
+
+It is necessary to have http://asciidoc.org/[AsciiDoc], 
+http://xmlsoft.org/XSLT/xsltproc2.html[xsltproc] and
+http://dblatex.sourceforge.net/[dblatex] installed on your
+system for Erlang.mk to generate documentation from AsciiDoc sources.
+
 === Writing AsciiDoc documentation
 === Writing AsciiDoc documentation
 
 
 http://asciidoc.org/[AsciiDoc] is a text document format for
 http://asciidoc.org/[AsciiDoc] is a text document format for

+ 2 - 1
doc/src/guide/contributing.asciidoc

@@ -100,7 +100,8 @@ this is a bug. You can either open a ticket or send a pull
 request.
 request.
 
 
 To make sure that the documentation changes work, install
 To make sure that the documentation changes work, install
-Asciidoc on your system and run `make docs`.
+the listed xref:asciidoc[Requirements] on your system and
+run `make docs`.
 
 
 === Feature requests
 === Feature requests
 
 

+ 1 - 1
doc/src/guide/deps.asciidoc

@@ -334,7 +334,7 @@ Erlang.mk will also export the `REBAR_DEPS_DIR` variable for
 compatibility with Rebar build tools, as long as they are
 compatibility with Rebar build tools, as long as they are
 recent enough.
 recent enough.
 
 
-=== Dependencies local to the repository
+=== Many applications in one repository
 
 
 In addition to the dependencies that are fetched, Erlang.mk
 In addition to the dependencies that are fetched, Erlang.mk
 also allows you to have dependencies local to your repository.
 also allows you to have dependencies local to your repository.