From 63a71926e9f498bc121cec30de1ccae6970da612 Mon Sep 17 00:00:00 2001 From: Rami Rosen Date: Sun, 20 Jan 2019 20:29:47 +0200 Subject: [PATCH] doc: add dependency for PDF in contributing guide 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 --- doc/guides/contributing/documentation.rst | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/doc/guides/contributing/documentation.rst b/doc/guides/contributing/documentation.rst index c28a95c348..c72280a297 100644 --- a/doc/guides/contributing/documentation.rst +++ b/doc/guides/contributing/documentation.rst @@ -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 `_ 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 ~~~~~~~~~~~~~~ -- 2.20.1