diff mbox series

[2/5] doc: enhance readability in memif example commands

Message ID 20231123114405.2611371-3-david.marchand@redhat.com (mailing list archive)
State Accepted, archived
Delegated to: David Marchand
Headers
Series Some documentation fixes |

Checks

Context Check Description
ci/checkpatch success coding style OK

Commit Message

David Marchand Nov. 23, 2023, 11:44 a.m. UTC 
  '#.' is a token for ordered lists in RST.
Add a space in those example commands.

Signed-off-by: David Marchand <david.marchand@redhat.com>
---
 doc/guides/nics/memif.rst | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

Comments

Bruce Richardson Nov. 23, 2023, 11:48 a.m. UTC | #1 
On Thu, Nov 23, 2023 at 12:44:02PM +0100, David Marchand wrote:
> '#.' is a token for ordered lists in RST.
> Add a space in those example commands.
> 
> Signed-off-by: David Marchand <david.marchand@redhat.com>
> ---
Acked-by: Bruce Richardson <bruce.richardson@intel.com>

As someone who runs DPDK on my systems as a regular user rather than root,
I'd also point out an alternative fix is to replace the "#" symbol, which
tends to be for the root prompt, with "$" symbol, more commonly used for
regular users. We should encourage running DPDK as non-root as much as we
can.
diff mbox series

Patch

diff --git a/doc/guides/nics/memif.rst b/doc/guides/nics/memif.rst
index afc574fdaa..2867b2f66d 100644
--- a/doc/guides/nics/memif.rst
+++ b/doc/guides/nics/memif.rst
@@ -216,15 +216,15 @@  In this example we run two instances of testpmd application and transmit packets
 
 First create ``server`` interface::
 
-    #./<build_dir>/app/dpdk-testpmd -l 0-1 --proc-type=primary --file-prefix=pmd1 --vdev=net_memif,role=server -- -i
+    # ./<build_dir>/app/dpdk-testpmd -l 0-1 --proc-type=primary --file-prefix=pmd1 --vdev=net_memif,role=server -- -i
 
 Now create ``client`` interface (server must be already running so the client will connect)::
 
-    #./<build_dir>/app/dpdk-testpmd -l 2-3 --proc-type=primary --file-prefix=pmd2 --vdev=net_memif -- -i
+    # ./<build_dir>/app/dpdk-testpmd -l 2-3 --proc-type=primary --file-prefix=pmd2 --vdev=net_memif -- -i
 
 You can also enable ``zero-copy`` on ``client`` interface::
 
-    #./<build_dir>/app/dpdk-testpmd -l 2-3 --proc-type=primary --file-prefix=pmd2 --vdev=net_memif,zero-copy=yes --single-file-segments -- -i
+    # ./<build_dir>/app/dpdk-testpmd -l 2-3 --proc-type=primary --file-prefix=pmd2 --vdev=net_memif,zero-copy=yes --single-file-segments -- -i
 
 Start forwarding packets::
 
@@ -260,7 +260,7 @@  To see socket filename use show memif command::
 
 Now create memif interface by running testpmd with these command line options::
 
-    #./dpdk-testpmd --vdev=net_memif,socket=/run/vpp/memif.sock -- -i
+    # ./dpdk-testpmd --vdev=net_memif,socket=/run/vpp/memif.sock -- -i
 
 Testpmd should now create memif client interface and try to connect to server.
 In testpmd set forward option to icmpecho and start forwarding::
@@ -283,7 +283,7 @@  The situation is analogous to cross connecting 2 ports of the NIC by cable.
 
 To set the loopback, just use the same socket and id with different roles::
 
-    #./dpdk-testpmd --vdev=net_memif0,role=server,id=0 --vdev=net_memif1,role=client,id=0 -- -i
+    # ./dpdk-testpmd --vdev=net_memif0,role=server,id=0 --vdev=net_memif1,role=client,id=0 -- -i
 
 Then start the communication::