From: Ajit Khaparde <ajit.khaparde@broadcom.com>
To: Thomas Monjalon <thomas@monjalon.net>
Cc: dpdk-dev <dev@dpdk.org>,
Somnath Kotur <somnath.kotur@broadcom.com>,
Beilei Xing <beilei.xing@intel.com>,
Qiming Yang <qiming.yang@intel.com>,
Qi Zhang <qi.z.zhang@intel.com>
Subject: Re: [dpdk-dev] [PATCH] doc: remove web references to internal guides
Date: Thu, 7 Oct 2021 08:49:25 -0700 [thread overview]
Message-ID: <CACZ4nhvfCM2WY3Rp5LSdA-MUzn+o456gkA4e=9+x53m3G3cuYA@mail.gmail.com> (raw)
In-Reply-To: <20211007122149.128825-1-thomas@monjalon.net>
[-- Attachment #1: Type: text/plain, Size: 3262 bytes --]
On Thu, Oct 7, 2021 at 5:22 AM Thomas Monjalon <thomas@monjalon.net> wrote:
> The guides should be referenced locally with RST syntax
> :doc: (beginning of page) or :ref: (specific chapter).
> The links to doc.dpdk.org/guides/ are removed.
>
> The links to the doc.dpdk.org/api/ are acceptable,
> but should not point to a specific version, so one is fixed.
>
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
>
Acked-by: Ajit Khaparde <ajit.khaparde@broadcom.com>
> ---
> doc/guides/nics/bnxt.rst | 2 +-
> doc/guides/nics/i40e.rst | 3 ++-
> doc/guides/nics/ice.rst | 3 ++-
> doc/guides/prog_guide/telemetry_lib.rst | 2 +-
> 4 files changed, 6 insertions(+), 4 deletions(-)
>
> diff --git a/doc/guides/nics/bnxt.rst b/doc/guides/nics/bnxt.rst
> index e75f4fa9e3..f2f5eff48d 100644
> --- a/doc/guides/nics/bnxt.rst
> +++ b/doc/guides/nics/bnxt.rst
> @@ -77,7 +77,7 @@ It can direct some traffic, for example data plane
> traffic, to DPDK.
> Rest of the traffic, for example control plane traffic, would be
> redirected to
> the traditional Linux networking stack.
>
> -Refer to https://doc.dpdk.org/guides/howto/flow_bifurcation.html
> +Refer to :doc:`../howto/flow_bifurcation`
>
> Benefits of the flow bifurcation include:
>
> diff --git a/doc/guides/nics/i40e.rst b/doc/guides/nics/i40e.rst
> index 07841dca24..ef91b3a1ac 100644
> --- a/doc/guides/nics/i40e.rst
> +++ b/doc/guides/nics/i40e.rst
> @@ -78,7 +78,8 @@ Linux Prerequisites
> Windows Prerequisites
> ---------------------
>
> -- Follow the DPDK `Getting Started Guide for Windows <
> https://doc.dpdk.org/guides/windows_gsg/index.html>`_ to setup the basic
> DPDK environment.
> +- Follow the :doc:`guide for Windows <../windows_gsg/run_apps>`
> + to setup the basic DPDK environment.
>
> - Identify the Intel® Ethernet adapter and get the latest NVM/FW version.
>
> diff --git a/doc/guides/nics/ice.rst b/doc/guides/nics/ice.rst
> index 8d43488353..f95fef8cf0 100644
> --- a/doc/guides/nics/ice.rst
> +++ b/doc/guides/nics/ice.rst
> @@ -28,7 +28,8 @@ Linux Prerequisites
> Windows Prerequisites
> ---------------------
>
> -- Follow the DPDK `Getting Started Guide for Windows <
> https://doc.dpdk.org/guides/windows_gsg/index.html>`_ to setup the basic
> DPDK environment.
> +- Follow the :doc:`guide for Windows <../windows_gsg/run_apps>`
> + to setup the basic DPDK environment.
>
> - Identify the Intel® Ethernet adapter and get the latest NVM/FW version.
>
> diff --git a/doc/guides/prog_guide/telemetry_lib.rst
> b/doc/guides/prog_guide/telemetry_lib.rst
> index 6ea16e9491..32f525a67f 100644
> --- a/doc/guides/prog_guide/telemetry_lib.rst
> +++ b/doc/guides/prog_guide/telemetry_lib.rst
> @@ -140,7 +140,7 @@ Giving the following response to the client::
> {"/example_lib/string_example": "This is an example string"}
>
> For more information on the range of data functions available in the API,
> -please refer to the `API doc <
> https://doc.dpdk.org/api-20.05/rte__telemetry_8h.html>`_
> +please refer to the `API doc <
> https://doc.dpdk.org/api/rte__telemetry_8h.html>`_
>
>
> Registering Commands
> --
> 2.33.0
>
>
next prev parent reply other threads:[~2021-10-07 15:49 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-10-07 12:21 Thomas Monjalon
2021-10-07 15:49 ` Ajit Khaparde [this message]
2021-10-08 7:34 ` David Marchand
2021-10-13 7:57 ` Thomas Monjalon
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to='CACZ4nhvfCM2WY3Rp5LSdA-MUzn+o456gkA4e=9+x53m3G3cuYA@mail.gmail.com' \
--to=ajit.khaparde@broadcom.com \
--cc=beilei.xing@intel.com \
--cc=dev@dpdk.org \
--cc=qi.z.zhang@intel.com \
--cc=qiming.yang@intel.com \
--cc=somnath.kotur@broadcom.com \
--cc=thomas@monjalon.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).