From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id D23EFA0583; Thu, 19 Mar 2020 09:29:25 +0100 (CET) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 3E8041C002; Thu, 19 Mar 2020 09:29:24 +0100 (CET) Received: from us-smtp-delivery-74.mimecast.com (us-smtp-delivery-74.mimecast.com [216.205.24.74]) by dpdk.org (Postfix) with ESMTP id 39412292D for ; Thu, 19 Mar 2020 09:29:23 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1584606562; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=aaqI6hVi94qYeUqeB8HemNDGxf2VAtqOjaUYPz4TMmY=; b=FA+ME3HsymBTzD1r7dPqiqmgvRFzDxQZWD94j3Y3Ts6jKYEu5YLb4osKL8EfduMmVZdDfY 7YUiJBK2pppyrANgL+ZIEJf+oYOHabh4wu2aC1G8Jk29wstYaDkCUhg82Mf2IEZR3GA6KU +Qpp+I0bDzJjlCW3y/x9g9WPsEg3tWQ= Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-193-uStFz-8LPka3Y50nN7EDDg-1; Thu, 19 Mar 2020 04:29:14 -0400 X-MC-Unique: uStFz-8LPka3Y50nN7EDDg-1 Received: from smtp.corp.redhat.com (int-mx07.intmail.prod.int.phx2.redhat.com [10.5.11.22]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 1B846800D5A; Thu, 19 Mar 2020 08:29:13 +0000 (UTC) Received: from dmarchan.remote.csb (unknown [10.40.193.243]) by smtp.corp.redhat.com (Postfix) with ESMTP id EBB9510016EB; Thu, 19 Mar 2020 08:29:10 +0000 (UTC) From: David Marchand To: dev@dpdk.org Cc: thomas@monjalon.net, stable@dpdk.org Date: Thu, 19 Mar 2020 09:28:59 +0100 Message-Id: <20200319082859.7162-1-david.marchand@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.84 on 10.5.11.22 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: quoted-printable Subject: [dpdk-dev] [PATCH] doc: prefer https when pointing to dpdk.org X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" 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 --- devtools/checkpatches.sh | 8 ++++++++ doc/guides/contributing/documentation.rst | 12 ++++++------ doc/guides/contributing/patches.rst | 16 ++++++++-------- doc/guides/contributing/stable.rst | 8 ++++---- doc/guides/contributing/vulnerability.rst | 6 +++--- doc/guides/freebsd_gsg/install_from_ports.rst | 2 +- doc/guides/howto/flow_bifurcation.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 +- doc/guides/rel_notes/deprecation.rst | 2 +- 11 files changed, 35 insertions(+), 27 deletions(-) diff --git a/devtools/checkpatches.sh b/devtools/checkpatches.sh index 1794468376..d3cf0e4c5d 100755 --- a/devtools/checkpatches.sh +++ b/devtools/checkpatches.sh @@ -70,6 +70,14 @@ check_forbidden_additions() { # =09=09-f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \ =09=09"$1" || res=3D1 =20 +=09# links must prefer https over http +=09awk -v FOLDERS=3D'doc' \ +=09=09-v EXPRESSIONS=3D'http://.*dpdk.org' \ +=09=09-v RET_ON_FAIL=3D1 \ +=09=09-v MESSAGE=3D'Using non https link to dpdk.org' \ +=09=09-f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \ +=09=09"$1" || res=3D1 + =09return $res } =20 diff --git a/doc/guides/contributing/documentation.rst b/doc/guides/contrib= uting/documentation.rst index 550d8dec28..375ea64ba8 100644 --- a/doc/guides/contributing/documentation.rst +++ b/doc/guides/contributing/documentation.rst @@ -82,7 +82,7 @@ added to by the developer. * **API documentation** =20 The API documentation explains how to use the public DPDK functions. - The `API index page `_ shows the generated API= documentation with related groups of functions. + The `API index page `_ shows the generated AP= I documentation with related groups of functions. =20 The API documentation should be updated via Doxygen comments when new fu= nctions are added. =20 @@ -561,14 +561,14 @@ Hyperlinks ~~~~~~~~~~ =20 * Links to external websites can be plain URLs. - The following is rendered as http://dpdk.org:: + The following is rendered as https://dpdk.org:: =20 - http://dpdk.org + https://dpdk.org =20 * They can contain alternative text. - The following is rendered as `Check out DPDK `_:: + The following is rendered as `Check out DPDK `_:: =20 - `Check out DPDK `_ + `Check out DPDK `_ =20 * An internal link can be generated by placing labels in the document with= the format ``.. _label_name``. =20 @@ -666,7 +666,7 @@ The following are some guidelines for use of Doxygen in= the DPDK API documentati */ =20 In the API documentation the functions will be rendered as links, see th= e - `online section of the rte_ethdev.h docs `_ that contains the above text. + `online section of the rte_ethdev.h docs `_ that contains the above text. =20 * 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 documen= tation section. diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/= patches.rst index 59442824a1..2ec044891e 100644 --- a/doc/guides/contributing/patches.rst +++ b/doc/guides/contributing/patches.rst @@ -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= . =20 -The mailing list for DPDK development is `dev@dpdk.org `_. -Contributors will need to `register for the mailing list `_ in order to submit patches. -It is also worth registering for the DPDK `Patchwork `_ +The mailing list for DPDK development is `dev@dpdk.org `_. +Contributors will need to `register for the mailing list `_ in order to submit patches. +It is also worth registering for the DPDK `Patchwork `_ =20 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 fol= lowing: main repository:: =20 git clone git://dpdk.org/dpdk - git clone http://dpdk.org/git/dpdk + git clone https://dpdk.org/git/dpdk =20 -sub-repositories (`list `_):: +sub-repositories (`list `_):: =20 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-* =20 Make your Changes ----------------- @@ -320,7 +320,7 @@ Patch for Stable Releases ~~~~~~~~~~~~~~~~~~~~~~~~~ =20 All fix patches to the master branch that are candidates for backporting -should also be CCed to the `stable@dpdk.org `_ +should also be CCed to the `stable@dpdk.org `_ mailing list. In the commit message body the Cc: stable@dpdk.org should be inserted as f= ollows:: =20 @@ -563,7 +563,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 =20 The Message ID can be found in the raw text of emails or at the top of eac= h Patchwork patch, -`for example `_. +`for example `_. Shallow threading (``--thread --no-chain-reply-to``) is preferred for a pa= tch series. =20 Once submitted your patches will appear on the mailing list and in Patchwo= rk. diff --git a/doc/guides/contributing/stable.rst b/doc/guides/contributing/s= table.rst index 90b3d8e44f..2947f27c6a 100644 --- a/doc/guides/contributing/stable.rst +++ b/doc/guides/contributing/stable.rst @@ -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. =20 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. =20 A LTS release may align with the declaration of a new major ABI version, please read the :doc:`abi_policy` for more information. @@ -107,7 +107,7 @@ The Stable and LTS release are coordinated on the stabl= e@dpdk.org mailing list. =20 All fix patches to the master branch that are candidates for backporting -should also be CCed to the `stable@dpdk.org `_ +should also be CCed to the `stable@dpdk.org `_ mailing list. =20 =20 @@ -118,7 +118,7 @@ A Stable Release will be released by: =20 * 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 `_ +* Sending an announcement to the `announce@dpdk.org `_ list. =20 -Stable releases are available on the `dpdk.org download page `_. +Stable releases are available on the `dpdk.org download page `_. diff --git a/doc/guides/contributing/vulnerability.rst b/doc/guides/contrib= uting/vulnerability.rst index 5484119d19..da00acd4f0 100644 --- a/doc/guides/contributing/vulnerability.rst +++ b/doc/guides/contributing/vulnerability.rst @@ -36,11 +36,11 @@ Report =20 Do not use Bugzilla (unsecured). Instead, send GPG-encrypted emails -to `security@dpdk.org `_. +to `security@dpdk.org `_. 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 peo= ple -`_. +`_. =20 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 d= isclose patches until the embargo is passed, otherwise they will be removed from the list. =20 Downstream stakeholders (in `security-prerelease list -`_), are: +`_), are: =20 * Operating system vendors known to package DPDK * Major DPDK users, considered trustworthy by the technical board, who diff --git a/doc/guides/freebsd_gsg/install_from_ports.rst b/doc/guides/fre= ebsd_gsg/install_from_ports.rst index 36dc4a417b..d946f3f3b2 100644 --- a/doc/guides/freebsd_gsg/install_from_ports.rst +++ b/doc/guides/freebsd_gsg/install_from_ports.rst @@ -72,7 +72,7 @@ These examples can be compiled and run as described in :r= ef:`compiling_sample_ap .. note:: =20 To install a copy of the DPDK compiled using gcc, please download the - official DPDK package from http://core.dpdk.org/download/ and install m= anually 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` =20 An example application can therefore be copied to a user's home directory = and diff --git a/doc/guides/howto/flow_bifurcation.rst b/doc/guides/howto/flow_= bifurcation.rst index a36126472c..68ac913e7d 100644 --- a/doc/guides/howto/flow_bifurcation.rst +++ b/doc/guides/howto/flow_bifurcation.rst @@ -294,4 +294,4 @@ The typical procedure to achieve this is as follows: 'not involved', while ``00`` or no mask means 'involved'. =20 * For more details of the configuration, refer to the - `cloud filter test plan `_ + `cloud filter test plan `_ diff --git a/doc/guides/linux_gsg/nic_perf_intel_platform.rst b/doc/guides/= linux_gsg/nic_perf_intel_platform.rst index c554c2159c..1dabbce244 100644 --- a/doc/guides/linux_gsg/nic_perf_intel_platform.rst +++ b/doc/guides/linux_gsg/nic_perf_intel_platform.rst @@ -64,7 +64,7 @@ This aligns with the previous output which showed that ea= ch channel has one memo Network Interface Card Requirements ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ =20 -Use a `DPDK supported `_ high end NIC suc= h as the Intel XL710 40GbE. +Use a `DPDK supported `_ high end NIC su= ch as the Intel XL710 40GbE. =20 Make sure each NIC has been flashed the latest version of NVM/firmware. =20 diff --git a/doc/guides/nics/enic.rst b/doc/guides/nics/enic.rst index 65e536d422..24d2b5713a 100644 --- a/doc/guides/nics/enic.rst +++ b/doc/guides/nics/enic.rst @@ -14,7 +14,7 @@ How to obtain ENIC PMD integrated DPDK -------------------------------------- =20 ENIC PMD support is integrated into the DPDK suite. dpdk-.tar.gz -should be downloaded from http://core.dpdk.org/download/ +should be downloaded from https://core.dpdk.org/download/ =20 =20 Configuration information diff --git a/doc/guides/prog_guide/cryptodev_lib.rst b/doc/guides/prog_guid= e/cryptodev_lib.rst index b91f7c8b7f..c14f750fa8 100644 --- a/doc/guides/prog_guide/cryptodev_lib.rst +++ b/doc/guides/prog_guide/cryptodev_lib.rst @@ -1128,4 +1128,4 @@ Asymmetric Crypto Device API ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ =20 The cryptodev Library API is described in the -`DPDK API Reference `_ +`DPDK API Reference `_ diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/de= precation.rst index 1339f54f5f..151a86460d 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -43,7 +43,7 @@ Deprecation Notices kernel module to the dpdk-kmods repository in the /linux/igb_uio/ direct= ory in 20.11. Minutes of Technical Board Meeting of `2019-11-06 - `_. + `_. =20 * lib: will fix extending some enum/define breaking the ABI. There are mul= tiple samples in DPDK that enum/define terminated with a ``.*MAX.*`` value whi= ch is --=20 2.23.0