[dpdk-stable] patch 'doc: prefer https when pointing to dpdk.org' has been queued to LTS release 18.11.9
Kevin Traynor
ktraynor at redhat.com
Fri Jun 5 20:25:25 CEST 2020
Hi,
FYI, your patch has been queued to LTS release 18.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 06/10/20. 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/kevintraynor/dpdk-stable-queue
This queued commit can be viewed at:
https://github.com/kevintraynor/dpdk-stable-queue/commit/b860ed986ebffbff3168776c03ba9136ca28458c
Thanks.
Kevin.
---
>From b860ed986ebffbff3168776c03ba9136ca28458c Mon Sep 17 00:00:00 2001
From: David Marchand <david.marchand at redhat.com>
Date: Thu, 19 Mar 2020 09:28:59 +0100
Subject: [PATCH] doc: prefer https when pointing to dpdk.org
[ upstream commit 3d4b2afb73f7f0988f8e66ba1b37f2a446e33868 ]
for file in $(git grep -l http://.*dpdk.org doc/); do
sed -i -e 's#http://\(.*dpdk.org\)#https://\1#g' $file;
done
Signed-off-by: David Marchand <david.marchand at redhat.com>
Acked-by: Kevin Traynor <ktraynor at redhat.com>
---
devtools/checkpatches.sh | 8 ++++++++
doc/guides/contributing/documentation.rst | 12 ++++++------
doc/guides/contributing/patches.rst | 16 ++++++++--------
doc/guides/contributing/stable.rst | 6 +++---
doc/guides/freebsd_gsg/install_from_ports.rst | 2 +-
doc/guides/linux_gsg/nic_perf_intel_platform.rst | 2 +-
doc/guides/nics/enic.rst | 2 +-
doc/guides/prog_guide/cryptodev_lib.rst | 2 +-
8 files changed, 29 insertions(+), 21 deletions(-)
diff --git a/devtools/checkpatches.sh b/devtools/checkpatches.sh
index c471731d45..acff1843af 100755
--- a/devtools/checkpatches.sh
+++ b/devtools/checkpatches.sh
@@ -57,4 +57,12 @@ check_forbidden_additions() { # <patch>
"$1" || res=1
+ # links must prefer https over http
+ awk -v FOLDERS='doc' \
+ -v EXPRESSIONS='http://.*dpdk.org' \
+ -v RET_ON_FAIL=1 \
+ -v MESSAGE='Using non https link to dpdk.org' \
+ -f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \
+ "$1" || res=1
+
return $res
}
diff --git a/doc/guides/contributing/documentation.rst b/doc/guides/contributing/documentation.rst
index a45b62bad3..8c782531d9 100644
--- a/doc/guides/contributing/documentation.rst
+++ b/doc/guides/contributing/documentation.rst
@@ -84,5 +84,5 @@ added to by the developer.
The API documentation explains how to use the public DPDK functions.
- The `API index page <http://doc.dpdk.org/api/>`_ shows the generated API documentation with related groups of functions.
+ The `API index page <https://doc.dpdk.org/api/>`_ shows the generated API documentation with related groups of functions.
The API documentation should be updated via Doxygen comments when new functions are added.
@@ -563,12 +563,12 @@ Hyperlinks
* Links to external websites can be plain URLs.
- The following is rendered as http://dpdk.org::
+ The following is rendered as https://dpdk.org::
- http://dpdk.org
+ https://dpdk.org
* They can contain alternative text.
- The following is rendered as `Check out DPDK <http://dpdk.org>`_::
+ The following is rendered as `Check out DPDK <https://dpdk.org>`_::
- `Check out DPDK <http://dpdk.org>`_
+ `Check out DPDK <https://dpdk.org>`_
* An internal link can be generated by placing labels in the document with the format ``.. _label_name``.
@@ -668,5 +668,5 @@ The following are some guidelines for use of Doxygen in the DPDK API documentati
In the API documentation the functions will be rendered as links, see the
- `online section of the rte_ethdev.h docs <http://doc.dpdk.org/api/rte__ethdev_8h.html>`_ that contains the above text.
+ `online section of the rte_ethdev.h docs <https://doc.dpdk.org/api/rte__ethdev_8h.html>`_ that contains the above text.
* The ``@see`` keyword can be used to create a *see also* link to another file or library.
diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst
index a1bfae1c93..28d4b67d66 100644
--- a/doc/guides/contributing/patches.rst
+++ b/doc/guides/contributing/patches.rst
@@ -29,7 +29,7 @@ The DPDK development process has the following features:
* After the ``-rc2`` release all patches should target the main repository.
-The mailing list for DPDK development is `dev at dpdk.org <http://mails.dpdk.org/archives/dev/>`_.
-Contributors will need to `register for the mailing list <http://mails.dpdk.org/listinfo/dev>`_ in order to submit patches.
-It is also worth registering for the DPDK `Patchwork <http://patches.dpdk.org/project/dpdk/list/>`_
+The mailing list for DPDK development is `dev at dpdk.org <https://mails.dpdk.org/archives/dev/>`_.
+Contributors will need to `register for the mailing list <https://mails.dpdk.org/listinfo/dev>`_ in order to submit patches.
+It is also worth registering for the DPDK `Patchwork <https://patches.dpdk.org/project/dpdk/list/>`_
If you are using the GitHub service, you can link your repository to
@@ -133,10 +133,10 @@ main repository::
git clone git://dpdk.org/dpdk
- git clone http://dpdk.org/git/dpdk
+ git clone https://dpdk.org/git/dpdk
-sub-repositories (`list <http://git.dpdk.org/next>`_)::
+sub-repositories (`list <https://git.dpdk.org/next>`_)::
git clone git://dpdk.org/next/dpdk-next-*
- git clone http://dpdk.org/git/next/dpdk-next-*
+ git clone https://dpdk.org/git/next/dpdk-next-*
Make your Changes
@@ -313,5 +313,5 @@ Patch for Stable Releases
All fix patches to the master branch that are candidates for backporting
-should also be CCed to the `stable at dpdk.org <http://mails.dpdk.org/listinfo/stable>`_
+should also be CCed to the `stable at dpdk.org <https://mails.dpdk.org/listinfo/stable>`_
mailing list.
In the commit message body the Cc: stable at dpdk.org should be inserted as follows::
@@ -514,5 +514,5 @@ If the patch is in relation to a previous email thread you can add it to the sam
The Message ID can be found in the raw text of emails or at the top of each Patchwork patch,
-`for example <http://patches.dpdk.org/patch/7646/>`_.
+`for example <https://patches.dpdk.org/patch/7646/>`_.
Shallow threading (``--thread --no-chain-reply-to``) is preferred for a patch series.
diff --git a/doc/guides/contributing/stable.rst b/doc/guides/contributing/stable.rst
index 2ac4f0a88b..88b46aee24 100644
--- a/doc/guides/contributing/stable.rst
+++ b/doc/guides/contributing/stable.rst
@@ -97,5 +97,5 @@ list.
All fix patches to the master branch that are candidates for backporting
-should also be CCed to the `stable at dpdk.org <http://mails.dpdk.org/listinfo/stable>`_
+should also be CCed to the `stable at dpdk.org <https://mails.dpdk.org/listinfo/stable>`_
mailing list.
@@ -108,8 +108,8 @@ A Stable Release will be released by:
* Tagging the release with YY.MM.n (year, month, number).
* Uploading a tarball of the release to dpdk.org.
-* Sending an announcement to the `announce at dpdk.org <http://mails.dpdk.org/listinfo/announce>`_
+* Sending an announcement to the `announce at dpdk.org <https://mails.dpdk.org/listinfo/announce>`_
list.
-Stable releases are available on the `dpdk.org download page <http://core.dpdk.org/download/>`_.
+Stable releases are available on the `dpdk.org download page <https://core.dpdk.org/download/>`_.
diff --git a/doc/guides/freebsd_gsg/install_from_ports.rst b/doc/guides/freebsd_gsg/install_from_ports.rst
index 253328eb10..2ac27f115c 100644
--- a/doc/guides/freebsd_gsg/install_from_ports.rst
+++ b/doc/guides/freebsd_gsg/install_from_ports.rst
@@ -63,5 +63,5 @@ environmental variables should be set as below:
To install a copy of the DPDK compiled using gcc, please download the
- official DPDK package from http://core.dpdk.org/download/ and install manually using
+ official DPDK package from https://core.dpdk.org/download/ and install manually using
the instructions given in the next chapter, :ref:`building_from_source`
diff --git a/doc/guides/linux_gsg/nic_perf_intel_platform.rst b/doc/guides/linux_gsg/nic_perf_intel_platform.rst
index 4e9afbdbc1..5fa6e3899d 100644
--- a/doc/guides/linux_gsg/nic_perf_intel_platform.rst
+++ b/doc/guides/linux_gsg/nic_perf_intel_platform.rst
@@ -65,5 +65,5 @@ Network Interface Card Requirements
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Use a `DPDK supported <http://core.dpdk.org/supported/>`_ high end NIC such as the Intel XL710 40GbE.
+Use a `DPDK supported <https://core.dpdk.org/supported/>`_ high end NIC such as the Intel XL710 40GbE.
Make sure each NIC has been flashed the latest version of NVM/firmware.
diff --git a/doc/guides/nics/enic.rst b/doc/guides/nics/enic.rst
index 773f13b0fc..c06363fc27 100644
--- a/doc/guides/nics/enic.rst
+++ b/doc/guides/nics/enic.rst
@@ -15,5 +15,5 @@ How to obtain ENIC PMD integrated DPDK
ENIC PMD support is integrated into the DPDK suite. dpdk-<version>.tar.gz
-should be downloaded from http://core.dpdk.org/download/
+should be downloaded from https://core.dpdk.org/download/
diff --git a/doc/guides/prog_guide/cryptodev_lib.rst b/doc/guides/prog_guide/cryptodev_lib.rst
index 7a95053ad5..53d797bcc1 100644
--- a/doc/guides/prog_guide/cryptodev_lib.rst
+++ b/doc/guides/prog_guide/cryptodev_lib.rst
@@ -1044,3 +1044,3 @@ Asymmetric Crypto Device API
The cryptodev Library API is described in the
-`DPDK API Reference <http://doc.dpdk.org/api/>`_
+`DPDK API Reference <https://doc.dpdk.org/api/>`_
--
2.21.3
---
Diff of the applied patch vs upstream commit (please double-check if non-empty:
---
--- - 2020-06-05 19:20:55.590329918 +0100
+++ 0088-doc-prefer-https-when-pointing-to-dpdk.org.patch 2020-06-05 19:20:50.998036542 +0100
@@ -1 +1 @@
-From 3d4b2afb73f7f0988f8e66ba1b37f2a446e33868 Mon Sep 17 00:00:00 2001
+From b860ed986ebffbff3168776c03ba9136ca28458c Mon Sep 17 00:00:00 2001
@@ -5,0 +6,2 @@
+[ upstream commit 3d4b2afb73f7f0988f8e66ba1b37f2a446e33868 ]
+
@@ -10,2 +11,0 @@
-Cc: stable at dpdk.org
-
@@ -18,2 +18 @@
- doc/guides/contributing/stable.rst | 8 ++++----
- doc/guides/contributing/vulnerability.rst | 6 +++---
+ doc/guides/contributing/stable.rst | 6 +++---
@@ -24,2 +23 @@
- doc/guides/rel_notes/deprecation.rst | 2 +-
- 10 files changed, 34 insertions(+), 26 deletions(-)
+ 8 files changed, 29 insertions(+), 21 deletions(-)
@@ -28 +26 @@
-index 42b833e0d7..158087f1ca 100755
+index c471731d45..acff1843af 100755
@@ -31 +29 @@
-@@ -79,4 +79,12 @@ check_forbidden_additions() { # <patch>
+@@ -57,4 +57,12 @@ check_forbidden_additions() { # <patch>
@@ -45 +43 @@
-index 550d8dec28..375ea64ba8 100644
+index a45b62bad3..8c782531d9 100644
@@ -48 +46 @@
-@@ -83,5 +83,5 @@ added to by the developer.
+@@ -84,5 +84,5 @@ added to by the developer.
@@ -55 +53 @@
-@@ -562,12 +562,12 @@ Hyperlinks
+@@ -563,12 +563,12 @@ Hyperlinks
@@ -72 +70 @@
-@@ -667,5 +667,5 @@ The following are some guidelines for use of Doxygen in the DPDK API documentati
+@@ -668,5 +668,5 @@ The following are some guidelines for use of Doxygen in the DPDK API documentati
@@ -80 +78 @@
-index 01e0a2f6ba..16b40225f2 100644
+index a1bfae1c93..28d4b67d66 100644
@@ -94 +92 @@
-@@ -131,10 +131,10 @@ main repository::
+@@ -133,10 +133,10 @@ main repository::
@@ -108 +106 @@
-@@ -321,5 +321,5 @@ Patch for Stable Releases
+@@ -313,5 +313,5 @@ Patch for Stable Releases
@@ -115 +113 @@
-@@ -566,5 +566,5 @@ If the patch is in relation to a previous email thread you can add it to the sam
+@@ -514,5 +514,5 @@ If the patch is in relation to a previous email thread you can add it to the sam
@@ -123 +121 @@
-index 626cebf655..890bbeccc3 100644
+index 2ac4f0a88b..88b46aee24 100644
@@ -126,8 +124 @@
-@@ -52,5 +52,5 @@ year's November (X.11) release will be maintained as an LTS for 2 years.
-
- After the X.11 release, an LTS branch will be created for it at
--http://git.dpdk.org/dpdk-stable where bugfixes will be backported to.
-+https://git.dpdk.org/dpdk-stable where bugfixes will be backported to.
-
- A LTS release may align with the declaration of a new major ABI version,
-@@ -109,5 +109,5 @@ list.
+@@ -97,5 +97,5 @@ list.
@@ -140 +131 @@
-@@ -120,6 +120,6 @@ A Stable Release will be released by:
+@@ -108,8 +108,8 @@ A Stable Release will be released by:
@@ -149,21 +139,0 @@
-diff --git a/doc/guides/contributing/vulnerability.rst b/doc/guides/contributing/vulnerability.rst
-index 5484119d19..da00acd4f0 100644
---- a/doc/guides/contributing/vulnerability.rst
-+++ b/doc/guides/contributing/vulnerability.rst
-@@ -37,9 +37,9 @@ Report
- Do not use Bugzilla (unsecured).
- Instead, send GPG-encrypted emails
--to `security at dpdk.org <http://core.dpdk.org/security#contact>`_.
-+to `security at dpdk.org <https://core.dpdk.org/security#contact>`_.
- Anyone can post to this list.
- In order to reduce the disclosure of a vulnerability in the early stages,
- membership of this list is intentionally limited to a `small number of people
--<http://mails.dpdk.org/roster/security>`_.
-+<https://mails.dpdk.org/roster/security>`_.
-
- It is additionally encouraged to GPG-sign one-on-one conversations
-@@ -189,5 +189,5 @@ until the embargo is passed, otherwise they will be removed from the list.
-
- Downstream stakeholders (in `security-prerelease list
--<http://mails.dpdk.org/roster/security-prerelease>`_), are:
-+<https://mails.dpdk.org/roster/security-prerelease>`_), are:
@@ -171 +141 @@
- * Operating system vendors known to package DPDK
+
@@ -173 +143 @@
-index 36dc4a417b..d946f3f3b2 100644
+index 253328eb10..2ac27f115c 100644
@@ -176 +146 @@
-@@ -73,5 +73,5 @@ These examples can be compiled and run as described in :ref:`compiling_sample_ap
+@@ -63,5 +63,5 @@ environmental variables should be set as below:
@@ -184 +154 @@
-index c554c2159c..1dabbce244 100644
+index 4e9afbdbc1..5fa6e3899d 100644
@@ -195 +165 @@
-index aa4fdc0e39..a28a7f4e47 100644
+index 773f13b0fc..c06363fc27 100644
@@ -206 +176 @@
-index b91f7c8b7f..c14f750fa8 100644
+index 7a95053ad5..53d797bcc1 100644
@@ -209 +179 @@
-@@ -1129,3 +1129,3 @@ Asymmetric Crypto Device API
+@@ -1044,3 +1044,3 @@ Asymmetric Crypto Device API
@@ -214,11 +183,0 @@
-diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
-index cf8b1eb7b0..e8fd441696 100644
---- a/doc/guides/rel_notes/deprecation.rst
-+++ b/doc/guides/rel_notes/deprecation.rst
-@@ -44,5 +44,5 @@ Deprecation Notices
- in 20.11.
- Minutes of Technical Board Meeting of `2019-11-06
-- <http://mails.dpdk.org/archives/dev/2019-November/151763.html>`_.
-+ <https://mails.dpdk.org/archives/dev/2019-November/151763.html>`_.
-
- * lib: will fix extending some enum/define breaking the ABI. There are multiple
More information about the stable
mailing list