[dpdk-stable] patch 'doc: add dependency for PDF in contributing guide' has been queued to LTS release 17.11.6

[Yongseok Koh]

Hi,

FYI, your patch has been queued to LTS release 17.11.6

Note it hasn't been pushed to http://dpdk.org/browse/dpdk-stable yet.
It will be pushed if I get no objection by 03/13/19. So please
shout if anyone has objection.

Also note that after the patch there's a diff of the upstream commit vs the patch applied
to the branch. If the code is different (ie: not only metadata diffs), due for example to
a change in context or macro names, please double check it.

Thanks.

Yongseok

---
>From 5465840325fb883fc30621ffceea8aedd629d116 Mon Sep 17 00:00:00 2001
From: Rami Rosen <ramirose at gmail.com>
Date: Sun, 20 Jan 2019 20:29:47 +0200
Subject: [PATCH] doc: add dependency for PDF in contributing guide

[ upstream commit 63a71926e9f498bc121cec30de1ccae6970da612 ]

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

Signed-off-by: Rami Rosen <ramirose at gmail.com>
---
 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 20a2c4822..6ccca11a2 100644
--- a/doc/guides/contributing/documentation.rst
+++ b/doc/guides/contributing/documentation.rst
@@ -201,6 +201,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
 ~~~~~~~~~~~~~~
-- 
2.11.0

---
  Diff of the applied patch vs upstream commit (please double-check if non-empty:
---
--- -	2019-03-08 09:46:43.645725566 -0800
+++ 0071-doc-add-dependency-for-PDF-in-contributing-guide.patch	2019-03-08 09:46:40.399409000 -0800
@@ -1,8 +1,10 @@
-From 63a71926e9f498bc121cec30de1ccae6970da612 Mon Sep 17 00:00:00 2001
+From 5465840325fb883fc30621ffceea8aedd629d116 Mon Sep 17 00:00:00 2001
 From: Rami Rosen <ramirose at gmail.com>
 Date: Sun, 20 Jan 2019 20:29:47 +0200
 Subject: [PATCH] doc: add dependency for PDF in contributing guide
 
+[ upstream commit 63a71926e9f498bc121cec30de1ccae6970da612 ]
+
 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
@@ -10,7 +12,6 @@
 sub-section 4.3.1 of the contributing guide ("Dependencies").
 
 Bugzilla ID: 182
-Cc: stable at dpdk.org
 
 Signed-off-by: Rami Rosen <ramirose at gmail.com>
 ---
@@ -18,10 +19,10 @@
  1 file changed, 13 insertions(+)
 
 diff --git a/doc/guides/contributing/documentation.rst b/doc/guides/contributing/documentation.rst
-index c28a95c34..c72280a29 100644
+index 20a2c4822..6ccca11a2 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:
+@@ -201,6 +201,19 @@ The main required packages can be installed as follows:
     # Red Hat/Fedora, selective install.
     sudo dnf     -y install texlive-collection-latexextra