[dpdk-stable] patch 'doc: fix build with Sphinx 4' has been queued to stable release 19.11.9

[Christian Ehrhardt <christian.ehrhardt@canonical.com>]

Hi,

FYI, your patch has been queued to stable release 19.11.9

Note it hasn't been pushed to http://dpdk.org/browse/dpdk-stable yet.
It will be pushed if I get no objections before 05/19/21. So please
shout if anyone has objections.

Also note that after the patch there's a diff of the upstream commit vs the
patch applied to the branch. This will indicate if there was any rebasing
needed to apply to the stable branch. If there were code changes for rebasing
(ie: not only metadata diffs), please double check that the rebase was
correctly done.

Queued patches are on a temporary branch at:
https://github.com/cpaelzer/dpdk-stable-queue

This queued commit can be viewed at:
https://github.com/cpaelzer/dpdk-stable-queue/commit/99df2c2aa1857b5fc4199dc52be3c636f8d1fc73

Thanks.

Christian Ehrhardt <christian.ehrhardt@canonical.com>

---
From 99df2c2aa1857b5fc4199dc52be3c636f8d1fc73 Mon Sep 17 00:00:00 2001
From: Thomas Monjalon <thomas@monjalon.net>
Date: Mon, 10 May 2021 22:45:37 +0200
Subject: [PATCH] doc: fix build with Sphinx 4

[ upstream commit 86ff0663639417f9d25907d09343a5c231e32a51 ]

Sphinx 4.0 became stricter with permalink configuration:
"
html_add_permalinks has been deprecated since v3.5.0.
Please use html_permalinks and html_permalinks_icon instead.
"

The new variable is used while keeping compatibility
with older Sphinx versions.

Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
Reviewed-by: David Marchand <david.marchand@redhat.com>
---
 doc/guides/conf.py | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/doc/guides/conf.py b/doc/guides/conf.py
index be02c2ba20..279b830d7b 100644
--- a/doc/guides/conf.py
+++ b/doc/guides/conf.py
@@ -33,7 +33,10 @@ except:
 project = 'Data Plane Development Kit'
 html_logo = '../logo/DPDK_logo_vertical_rev_small.png'
 latex_logo = '../logo/DPDK_logo_horizontal_tag.png'
-html_add_permalinks = ""
+if LooseVersion(sphinx_version) >= LooseVersion('3.5'):
+    html_permalinks = False
+else:
+    html_add_permalinks = ""
 html_show_copyright = False
 highlight_language = 'none'
 
-- 
2.31.1

---
  Diff of the applied patch vs upstream commit (please double-check if non-empty:
---
--- -	2021-05-17 17:40:37.580815026 +0200
+++ 0210-doc-fix-build-with-Sphinx-4.patch	2021-05-17 17:40:29.611812942 +0200
@@ -1 +1 @@
-From 86ff0663639417f9d25907d09343a5c231e32a51 Mon Sep 17 00:00:00 2001
+From 99df2c2aa1857b5fc4199dc52be3c636f8d1fc73 Mon Sep 17 00:00:00 2001
@@ -5,0 +6,2 @@
+[ upstream commit 86ff0663639417f9d25907d09343a5c231e32a51 ]
+
@@ -15,2 +16,0 @@
-Cc: stable@dpdk.org
-
@@ -25 +25 @@
-index ec59aeae7e..c22caaa247 100644
+index be02c2ba20..279b830d7b 100644
@@ -28 +28 @@
-@@ -31,7 +31,10 @@ stop_on_error = ('-W' in argv)
+@@ -33,7 +33,10 @@ except: