doc: fix references to removed guide

Message ID 20200930172717.1113693-1-thomas@monjalon.net (mailing list archive)
State Accepted, archived
Headers
Series doc: fix references to removed guide |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK
ci/travis-robot success Travis build: passed

Commit Message

Thomas Monjalon Sept. 30, 2020, 5:27 p.m. UTC
  The page "Development Kit Build System" was about make,
so it has been removed. A better help is in the Linux guide
(note: mlx4/mlx5 are supported on Linux only for now).

Fixes: 3cc6ecfdfe85 ("build: remove makefiles")

Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
---
 doc/guides/nics/mlx4.rst | 4 ++--
 doc/guides/nics/mlx5.rst | 4 ++--
 2 files changed, 4 insertions(+), 4 deletions(-)
  

Comments

David Marchand Sept. 30, 2020, 7:07 p.m. UTC | #1
On Wed, Sep 30, 2020 at 7:27 PM Thomas Monjalon <thomas@monjalon.net> wrote:
>
> The page "Development Kit Build System" was about make,
> so it has been removed. A better help is in the Linux guide
> (note: mlx4/mlx5 are supported on Linux only for now).
>
> Fixes: 3cc6ecfdfe85 ("build: remove makefiles")
>
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> ---
>  doc/guides/nics/mlx4.rst | 4 ++--
>  doc/guides/nics/mlx5.rst | 4 ++--
>  2 files changed, 4 insertions(+), 4 deletions(-)
>
> diff --git a/doc/guides/nics/mlx4.rst b/doc/guides/nics/mlx4.rst
> index 1f1e2f6c77..6818b6af51 100644
> --- a/doc/guides/nics/mlx4.rst
> +++ b/doc/guides/nics/mlx4.rst
> @@ -335,8 +335,8 @@ Quick Start Guide
>
>          service openibd restart
>
> -4. Compile DPDK and you are ready to go. See instructions on
> -   :ref:`Development Kit Build System <Development_Kit_Build_System>`
> +4. Install DPDK and you are ready to go.
> +   See :doc:`compilation instructions <../linux_gsg/build_dpdk>`.
>
>  Performance tuning
>  ------------------
> diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst
> index 211c0c5a6c..b0614ae335 100644
> --- a/doc/guides/nics/mlx5.rst
> +++ b/doc/guides/nics/mlx5.rst
> @@ -1247,8 +1247,8 @@ Quick Start Guide on OFED/EN
>
>          echo [num_vfs] > /sys/class/infiniband/mlx5_0/device/sriov_numvfs
>
> -6. Compile DPDK and you are ready to go. See instructions on
> -   :ref:`Development Kit Build System <Development_Kit_Build_System>`
> +6. Install DPDK and you are ready to go.
> +   See :doc:`compilation instructions <../linux_gsg/build_dpdk>`.
>
>  Enable switchdev mode
>  ---------------------
> --
> 2.28.0
>

Acked-by: David Marchand <david.marchand@redhat.com>
  
Power, Ciara Oct. 1, 2020, 10:15 a.m. UTC | #2
>-----Original Message-----
>From: David Marchand <david.marchand@redhat.com>
>Sent: Wednesday 30 September 2020 20:08
>To: Thomas Monjalon <thomas@monjalon.net>
>Cc: dev <dev@dpdk.org>; Richardson, Bruce <bruce.richardson@intel.com>;
>Matan Azrad <matan@nvidia.com>; Shahaf Shuler <shahafs@nvidia.com>;
>Viacheslav Ovsiienko <viacheslavo@nvidia.com>; Power, Ciara
><ciara.power@intel.com>; Ruifeng Wang <ruifeng.wang@arm.com>
>Subject: Re: [PATCH] doc: fix references to removed guide
>
>On Wed, Sep 30, 2020 at 7:27 PM Thomas Monjalon
><thomas@monjalon.net> wrote:
>>
>> The page "Development Kit Build System" was about make, so it has been
>> removed. A better help is in the Linux guide
>> (note: mlx4/mlx5 are supported on Linux only for now).
>>
>> Fixes: 3cc6ecfdfe85 ("build: remove makefiles")
>>
>> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
>> ---
>>  doc/guides/nics/mlx4.rst | 4 ++--
>>  doc/guides/nics/mlx5.rst | 4 ++--
>>  2 files changed, 4 insertions(+), 4 deletions(-)
>>
>> diff --git a/doc/guides/nics/mlx4.rst b/doc/guides/nics/mlx4.rst index
>> 1f1e2f6c77..6818b6af51 100644
>> --- a/doc/guides/nics/mlx4.rst
>> +++ b/doc/guides/nics/mlx4.rst
>> @@ -335,8 +335,8 @@ Quick Start Guide
>>
>>          service openibd restart
>>
>> -4. Compile DPDK and you are ready to go. See instructions on
>> -   :ref:`Development Kit Build System <Development_Kit_Build_System>`
>> +4. Install DPDK and you are ready to go.
>> +   See :doc:`compilation instructions <../linux_gsg/build_dpdk>`.
>>
>>  Performance tuning
>>  ------------------
>> diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst index
>> 211c0c5a6c..b0614ae335 100644
>> --- a/doc/guides/nics/mlx5.rst
>> +++ b/doc/guides/nics/mlx5.rst
>> @@ -1247,8 +1247,8 @@ Quick Start Guide on OFED/EN
>>
>>          echo [num_vfs] >
>> /sys/class/infiniband/mlx5_0/device/sriov_numvfs
>>
>> -6. Compile DPDK and you are ready to go. See instructions on
>> -   :ref:`Development Kit Build System <Development_Kit_Build_System>`
>> +6. Install DPDK and you are ready to go.
>> +   See :doc:`compilation instructions <../linux_gsg/build_dpdk>`.
>>
>>  Enable switchdev mode
>>  ---------------------
>> --
>> 2.28.0
>>
>
>Acked-by: David Marchand <david.marchand@redhat.com>
>
>
>--
>David Marchand


Acked-by: Ciara Power <ciara.power@intel.com>

Missed this in my doc changes for make removal, thanks.
Ciara
  
Thomas Monjalon Oct. 1, 2020, 2:41 p.m. UTC | #3
> >> The page "Development Kit Build System" was about make, so it has been
> >> removed. A better help is in the Linux guide
> >> (note: mlx4/mlx5 are supported on Linux only for now).
> >>
> >> Fixes: 3cc6ecfdfe85 ("build: remove makefiles")
> >>
> >> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> >
> >Acked-by: David Marchand <david.marchand@redhat.com>
> 
> Acked-by: Ciara Power <ciara.power@intel.com>

Applied
  

Patch

diff --git a/doc/guides/nics/mlx4.rst b/doc/guides/nics/mlx4.rst
index 1f1e2f6c77..6818b6af51 100644
--- a/doc/guides/nics/mlx4.rst
+++ b/doc/guides/nics/mlx4.rst
@@ -335,8 +335,8 @@  Quick Start Guide
 
         service openibd restart
 
-4. Compile DPDK and you are ready to go. See instructions on
-   :ref:`Development Kit Build System <Development_Kit_Build_System>`
+4. Install DPDK and you are ready to go.
+   See :doc:`compilation instructions <../linux_gsg/build_dpdk>`.
 
 Performance tuning
 ------------------
diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst
index 211c0c5a6c..b0614ae335 100644
--- a/doc/guides/nics/mlx5.rst
+++ b/doc/guides/nics/mlx5.rst
@@ -1247,8 +1247,8 @@  Quick Start Guide on OFED/EN
 
         echo [num_vfs] > /sys/class/infiniband/mlx5_0/device/sriov_numvfs
 
-6. Compile DPDK and you are ready to go. See instructions on
-   :ref:`Development Kit Build System <Development_Kit_Build_System>`
+6. Install DPDK and you are ready to go.
+   See :doc:`compilation instructions <../linux_gsg/build_dpdk>`.
 
 Enable switchdev mode
 ---------------------