patches for DPDK stable branches
 help / color / mirror / Atom feed
From: Rami Rosen <ramirose@gmail.com>
To: dev@dpdk.org
Cc: stable@dpdk.org, vipin.varghese@intel.com,
	Rami Rosen <ramirose@gmail.com>
Subject: [dpdk-stable] [PATCH] doc: add missing package dependency in contributors guide
Date: Sun, 20 Jan 2019 20:29:47 +0200	[thread overview]
Message-ID: <20190120182947.7643-1-ramirose@gmail.com> (raw)

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").

Cc: stable@dpdk.org
Signed-off-by: Rami Rosen <ramirose@gmail.com>
---
 doc/guides/contributing/documentation.rst | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/doc/guides/contributing/documentation.rst b/doc/guides/contributing/documentation.rst
index c28a95c34..83e39d189 100644
--- a/doc/guides/contributing/documentation.rst
+++ b/doc/guides/contributing/documentation.rst
@@ -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
 ~~~~~~~~~~~~~~
-- 
2.19.2

             reply	other threads:[~2019-01-20 18:30 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-01-20 18:29 Rami Rosen [this message]
2019-01-28  1:01 ` [dpdk-stable] [dpdk-dev] " Thomas Monjalon

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20190120182947.7643-1-ramirose@gmail.com \
    --to=ramirose@gmail.com \
    --cc=dev@dpdk.org \
    --cc=stable@dpdk.org \
    --cc=vipin.varghese@intel.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).