doc: add missing package dependency in contributors guide
PATCH 1/1 doc: add missing package dependency in contributors 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 reproted 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").
--- doc/guides/contributing/documentation.rst | 11 +++++++++++ 1 file changed, 11 insertions(+)
doc/guides/contributing/documentation.rst +11 -0
@@ -204,6 +204,17 @@ 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, selective install. + sudo dnf -y install latexmk Build commands ~~~~~~~~~~~~~~
Signature · 1 line
2.19.2
20/01/2019 19:29, Rami Rosen:
Quoted 8 lines
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 reproted 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").Signed-off-by Rami Rosen <[email protected]>
Bugzilla ID: 182
Applied with small changes, thanks.