[dpdk-dev] [PATCH] doc: improve lstopo tip

[dpdk-dev] [PATCH] doc: improve lstopo tip

[Thomas Monjalon]

The tool lstopo from hwloc package can provide a graphical
or textual view.
In its textual form, the option --merge gives a shorter summary
which fits well with the DPDK need.

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

diff --git a/doc/guides/linux_gsg/build_sample_apps.rst b/doc/guides/linux_gsg/build_sample_apps.rst
index 78652549a7..95e7bb067d 100644
--- a/doc/guides/linux_gsg/build_sample_apps.rst
+++ b/doc/guides/linux_gsg/build_sample_apps.rst
@@ -142,7 +142,7 @@ This can be useful when using other processors to understand the mapping of the
     On Fedora Linux, this may be installed and run using the following command::
 
         sudo yum install hwloc
-        ./lstopo
+        lstopo
 
 .. warning::
 
diff --git a/doc/guides/nics/mlx4.rst b/doc/guides/nics/mlx4.rst
index 9742ddb268..a25add7c47 100644
--- a/doc/guides/nics/mlx4.rst
+++ b/doc/guides/nics/mlx4.rst
@@ -308,7 +308,7 @@ Performance tuning
    for better performance. For VMs, verify that the right CPU
    and NUMA node are pinned according to the above. Run::
 
-        lstopo-no-graphics
+        lstopo-no-graphics --merge
 
    to identify the NUMA node to which the PCIe adapter is connected.
 
diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst
index 7c50497fbc..ac4d0e0450 100644
--- a/doc/guides/nics/mlx5.rst
+++ b/doc/guides/nics/mlx5.rst
@@ -1401,7 +1401,7 @@ Performance tuning
    for better performance. For VMs, verify that the right CPU
    and NUMA node are pinned according to the above. Run::
 
-        lstopo-no-graphics
+        lstopo-no-graphics --merge
 
    to identify the NUMA node to which the PCIe adapter is connected.
 
-- 
2.30.1

[dpdk-dev] [PATCH v2] doc: improve lstopo tip

[Thomas Monjalon]

The tool lstopo from hwloc package can provide a graphical
or textual view.
In its textual form, the option --merge gives a shorter summary
which fits well with the DPDK need.

Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
---
v2: add textual output in Linux guide
---
 doc/guides/linux_gsg/build_sample_apps.rst | 13 +++++++++----
 doc/guides/nics/mlx4.rst                   |  2 +-
 doc/guides/nics/mlx5.rst                   |  2 +-
 3 files changed, 11 insertions(+), 6 deletions(-)

diff --git a/doc/guides/linux_gsg/build_sample_apps.rst b/doc/guides/linux_gsg/build_sample_apps.rst
index 78652549a7..709b301427 100644
--- a/doc/guides/linux_gsg/build_sample_apps.rst
+++ b/doc/guides/linux_gsg/build_sample_apps.rst
@@ -138,11 +138,16 @@ This can be useful when using other processors to understand the mapping of the
 
 .. note::
 
-    A more graphical view of the logical core layout may be obtained using the ``lstopo`` Linux utility.
-    On Fedora Linux, this may be installed and run using the following command::
+   A more graphical view of the logical core layout
+   may be obtained using the ``lstopo`` Linux utility.
+   On Fedora, this may be installed and run using the following commands::
 
-        sudo yum install hwloc
-        ./lstopo
+      sudo yum install hwloc
+      lstopo
+
+   This command produces a quite short textual output::
+
+      lstopo-no-graphics --merge
 
 .. warning::
 
diff --git a/doc/guides/nics/mlx4.rst b/doc/guides/nics/mlx4.rst
index 9742ddb268..a25add7c47 100644
--- a/doc/guides/nics/mlx4.rst
+++ b/doc/guides/nics/mlx4.rst
@@ -308,7 +308,7 @@ Performance tuning
    for better performance. For VMs, verify that the right CPU
    and NUMA node are pinned according to the above. Run::
 
-        lstopo-no-graphics
+        lstopo-no-graphics --merge
 
    to identify the NUMA node to which the PCIe adapter is connected.
 
diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst
index 220c6e505a..83299646dd 100644
--- a/doc/guides/nics/mlx5.rst
+++ b/doc/guides/nics/mlx5.rst
@@ -1496,7 +1496,7 @@ Performance tuning
    for better performance. For VMs, verify that the right CPU
    and NUMA node are pinned according to the above. Run::
 
-        lstopo-no-graphics
+        lstopo-no-graphics --merge
 
    to identify the NUMA node to which the PCIe adapter is connected.
 
-- 
2.31.1

Re: [dpdk-dev] [PATCH v2] doc: improve lstopo tip

[Thomas Monjalon]

21/05/2021 11:06, Thomas Monjalon:
> The tool lstopo from hwloc package can provide a graphical
> or textual view.
> In its textual form, the option --merge gives a shorter summary
> which fits well with the DPDK need.
> 
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>

I think this option can be quite useful.

Applied