doc: fix wrong hugepages setting path

Message ID 20201206173114.3954124-1-walimisdev@gmail.com (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers
Series doc: fix wrong hugepages setting path |

Checks

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

Commit Message

walimisdev@gmail.com Dec. 6, 2020, 5:31 p.m. UTC
  From: Wang Liming <walimisdev@gmail.com>

Remove redundant "nr_hugepages" words from mlx4 and mlx5 doc.

Signed-off-by: Wang Liming <walimisdev@gmail.com>
---
 doc/guides/nics/mlx4.rst | 2 +-
 doc/guides/nics/mlx5.rst | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)
  

Comments

Stephen Hemminger Dec. 6, 2020, 5:43 p.m. UTC | #1
On Mon,  7 Dec 2020 01:31:14 +0800
walimisdev@gmail.com wrote:

> From: Wang Liming <walimisdev@gmail.com>
> 
> Remove redundant "nr_hugepages" words from mlx4 and mlx5 doc.
> 
> Signed-off-by: Wang Liming <walimisdev@gmail.com>
> ---
>  doc/guides/nics/mlx4.rst | 2 +-
>  doc/guides/nics/mlx5.rst | 2 +-
>  2 files changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/doc/guides/nics/mlx4.rst b/doc/guides/nics/mlx4.rst
> index 354c2bb82..b40954e88 100644
> --- a/doc/guides/nics/mlx4.rst
> +++ b/doc/guides/nics/mlx4.rst
> @@ -405,7 +405,7 @@ devices managed by librte_net_mlx4.
>  
>  #. Request huge pages::
>  
> -      echo 1024 > /sys/kernel/mm/hugepages/hugepages-2048kB/nr_hugepages/nr_hugepages
> +      echo 1024 > /sys/kernel/mm/hugepages/hugepages-2048kB/nr_hugepages
>  
>  #. Start testpmd with basic parameters::
>  
> diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst
> index 3bda0f841..afefe6a3a 100644
> --- a/doc/guides/nics/mlx5.rst
> +++ b/doc/guides/nics/mlx5.rst
> @@ -1594,7 +1594,7 @@ ConnectX-4/ConnectX-5/ConnectX-6/BlueField devices managed by librte_net_mlx5.
>  
>  #. Request huge pages::
>  
> -      echo 1024 > /sys/kernel/mm/hugepages/hugepages-2048kB/nr_hugepages/nr_hugepages
> +      echo 1024 > /sys/kernel/mm/hugepages/hugepages-2048kB/nr_hugepages
>  
>  #. Start testpmd with basic parameters::
>  

Could we change the drivers to refer to the existing hugepages script
rather than doing "roll your own"
  
Thomas Monjalon Feb. 11, 2021, 6:19 p.m. UTC | #2
06/12/2020 18:43, Stephen Hemminger:
> On Mon,  7 Dec 2020 01:31:14 +0800
> walimisdev@gmail.com wrote:
> 
> > From: Wang Liming <walimisdev@gmail.com>
> > 
> > Remove redundant "nr_hugepages" words from mlx4 and mlx5 doc.
> > 
> > Signed-off-by: Wang Liming <walimisdev@gmail.com>
> > ---
> >  doc/guides/nics/mlx4.rst | 2 +-
> >  doc/guides/nics/mlx5.rst | 2 +-
> >  2 files changed, 2 insertions(+), 2 deletions(-)
[...]
> > --- a/doc/guides/nics/mlx5.rst
> > +++ b/doc/guides/nics/mlx5.rst
> >  #. Request huge pages::
> >  
> > -      echo 1024 > /sys/kernel/mm/hugepages/hugepages-2048kB/nr_hugepages/nr_hugepages
> > +      echo 1024 > /sys/kernel/mm/hugepages/hugepages-2048kB/nr_hugepages
> 
> Could we change the drivers to refer to the existing hugepages script
> rather than doing "roll your own"

I agree. I've sent a patch to use the new script wherever needed:
	https://patches.dpdk.org/patch/87877/
  

Patch

diff --git a/doc/guides/nics/mlx4.rst b/doc/guides/nics/mlx4.rst
index 354c2bb82..b40954e88 100644
--- a/doc/guides/nics/mlx4.rst
+++ b/doc/guides/nics/mlx4.rst
@@ -405,7 +405,7 @@  devices managed by librte_net_mlx4.
 
 #. Request huge pages::
 
-      echo 1024 > /sys/kernel/mm/hugepages/hugepages-2048kB/nr_hugepages/nr_hugepages
+      echo 1024 > /sys/kernel/mm/hugepages/hugepages-2048kB/nr_hugepages
 
 #. Start testpmd with basic parameters::
 
diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst
index 3bda0f841..afefe6a3a 100644
--- a/doc/guides/nics/mlx5.rst
+++ b/doc/guides/nics/mlx5.rst
@@ -1594,7 +1594,7 @@  ConnectX-4/ConnectX-5/ConnectX-6/BlueField devices managed by librte_net_mlx5.
 
 #. Request huge pages::
 
-      echo 1024 > /sys/kernel/mm/hugepages/hugepages-2048kB/nr_hugepages/nr_hugepages
+      echo 1024 > /sys/kernel/mm/hugepages/hugepages-2048kB/nr_hugepages
 
 #. Start testpmd with basic parameters::