doc: add dependency for PDF in contributing guide
authorRami Rosen <ramirose@gmail.com>
Sun, 20 Jan 2019 18:29:47 +0000 (20:29 +0200)
committerThomas Monjalon <thomas@monjalon.net>
Mon, 28 Jan 2019 00:59:01 +0000 (01:59 +0100)
There is a missing depenency for building docs with "make doc-guides-pdf".
This causes it to break with "make[3]: latexmk: Command not found". This
was observed and reported in https://bugs.dpdk.org/show_bug.cgi?id=182
This patch fixes this issue by adding the latexmk package dependency in
sub-section 4.3.1 of the contributing guide ("Dependencies").

Bugzilla ID: 182
Cc: stable@dpdk.org
Signed-off-by: Rami Rosen <ramirose@gmail.com>
doc/guides/contributing/documentation.rst

index c28a95c..c72280a 100644 (file)
@@ -204,6 +204,19 @@ The main required packages can be installed as follows:
    # Red Hat/Fedora, selective install.
    sudo dnf     -y install texlive-collection-latexextra
 
+`Latexmk <http://personal.psu.edu/jcc8/software/latexmk-jcc/>`_ is a perl script
+for running LaTeX for resolving cross references,
+and it also runs auxiliary programs like bibtex, makeindex if necessary, and dvips.
+It has also a number of other useful capabilities (see man 1 latexmk).
+
+.. code-block:: console
+
+   # Ubuntu/Debian.
+   sudo apt-get -y install latexmk
+
+   # Red Hat/Fedora.
+   sudo dnf     -y install latexmk
+
 
 Build commands
 ~~~~~~~~~~~~~~