d/numam-dpdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

doc: prefer https when pointing to dpdk.org

Browse Source 
for file in $(git grep -l http://.*dpdk.org doc/); do
  sed -i -e 's#http://\(.*dpdk.org\)#https://\1#g' $file;
done

Cc: stable@dpdk.org

Signed-off-by: David Marchand <david.marchand@redhat.com>
Acked-by: Kevin Traynor <ktraynor@redhat.com>
This commit is contained in:
David Marchand 2020-03-19 09:28:59 +01:00 committed by Thomas Monjalon
parent ba8af67fcd
commit 3d4b2afb73
10 changed files with 34 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
devtools/checkpatches.sh
View File

@ -78,6 +78,14 @@ check_forbidden_additions() { # <patch>
-f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \
"$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
}

12
doc/guides/contributing/documentation.rst
View File

@ -82,7 +82,7 @@ added to by the developer.
* **API documentation**
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.
@ -561,14 +561,14 @@ 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``.
@ -666,7 +666,7 @@ 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.
This directive should be placed on one line at the bottom of the documentation section.

16
doc/guides/contributing/patches.rst
View File

@ -28,9 +28,9 @@ The DPDK development process has the following features:
* All sub-repositories are merged into main repository for ``-rc1`` and ``-rc2`` versions of the release.
* After the ``-rc2`` release all patches should target the main repository.
The mailing list for DPDK development is `dev@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@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
the ``travis-ci.org`` build service. When you push patches to your GitHub
@ -130,12 +130,12 @@ The source code can be cloned using either of the following:
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
-----------------
@ -320,7 +320,7 @@ Patch for Stable Releases
~~~~~~~~~~~~~~~~~~~~~~~~~
All fix patches to the master branch that are candidates for backporting
should also be CCed to the `stable@dpdk.org <http://mails.dpdk.org/listinfo/stable>`_
should also be CCed to the `stable@dpdk.org <https://mails.dpdk.org/listinfo/stable>`_
mailing list.
In the commit message body the Cc: stable@dpdk.org should be inserted as follows::
@ -565,7 +565,7 @@ If the patch is in relation to a previous email thread you can add it to the sam
git send-email --to dev@dpdk.org --in-reply-to <1234-foo@bar.com> 000*.patch
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.
Once submitted your patches will appear on the mailing list and in Patchwork.

8
doc/guides/contributing/stable.rst
View File

@ -51,7 +51,7 @@ agreement and a commitment from a maintainer. The current policy is that each
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,
please read the :doc:`abi_policy` for more information.
@ -108,7 +108,7 @@ The Stable and LTS release are coordinated on the stable@dpdk.org mailing
list.
All fix patches to the master branch that are candidates for backporting
should also be CCed to the `stable@dpdk.org <http://mails.dpdk.org/listinfo/stable>`_
should also be CCed to the `stable@dpdk.org <https://mails.dpdk.org/listinfo/stable>`_
mailing list.
@ -119,7 +119,7 @@ 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@dpdk.org <http://mails.dpdk.org/listinfo/announce>`_
* Sending an announcement to the `announce@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/>`_.

6
doc/guides/contributing/vulnerability.rst
View File

@ -36,11 +36,11 @@ Report
Do not use Bugzilla (unsecured).
Instead, send GPG-encrypted emails
to `security@dpdk.org <http://core.dpdk.org/security#contact>`_.
to `security@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
as part of the security process.
@ -188,7 +188,7 @@ Downstream stakeholders are expected not to deploy or disclose patches
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:
* Operating system vendors known to package DPDK
* Major DPDK users, considered trustworthy by the technical board, who

2
doc/guides/freebsd_gsg/install_from_ports.rst
View File

@ -72,7 +72,7 @@ These examples can be compiled and run as described in :ref:`compiling_sample_ap
.. note::
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`
An example application can therefore be copied to a user's home directory and

2
doc/guides/linux_gsg/nic_perf_intel_platform.rst
View File

@ -64,7 +64,7 @@ This aligns with the previous output which showed that each channel has one memo
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.

2
doc/guides/nics/enic.rst
View File

@ -14,7 +14,7 @@ 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/
Configuration information

2
doc/guides/prog_guide/cryptodev_lib.rst
View File

@ -1128,4 +1128,4 @@ 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
doc/guides/rel_notes/deprecation.rst
View File

@ -43,7 +43,7 @@ Deprecation Notices
kernel module to the dpdk-kmods repository in the /linux/igb_uio/ directory
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
samples in DPDK that enum/define terminated with a ``.*MAX.*`` value which is