[dpdk-dev] [PATCH] doc: update pcap documentation

[dpdk-dev] [PATCH] doc: update pcap documentation

[Ferruh Yigit]

Add note about PMD expects the network interfaces provided to be up,
documented behavior to set expectations right.

Also added minor fix.

Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
---
Cc: Vipin Varghese <vipin.varghese@intel.com>
Cc: Michael Glynn <michael.j.glynn@intel.com>
---
 doc/guides/nics/pcap_ring.rst | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/doc/guides/nics/pcap_ring.rst b/doc/guides/nics/pcap_ring.rst
index de47f68cf..b3b5cb49e 100644
--- a/doc/guides/nics/pcap_ring.rst
+++ b/doc/guides/nics/pcap_ring.rst
@@ -5,7 +5,7 @@ Libpcap and Ring Based Poll Mode Drivers
 ========================================
 
 In addition to Poll Mode Drivers (PMDs) for physical and virtual hardware,
-the DPDK also includes two pure-software PMDs. These two drivers are:
+the DPDK also includes pure-software PMDs, two of these drivers are:
 
 *   A libpcap -based PMD (librte_pmd_pcap) that reads and writes packets using libpcap,
     - both from files on disk, as well as from physical NIC devices using standard Linux kernel drivers.
@@ -148,6 +148,12 @@ Otherwise, the first 512 packets from the input pcap file will be discarded by t
         --vdev 'net_pcap0,rx_pcap=file_rx.pcap,tx_pcap=file_tx.pcap' \
         -- --port-topology=chained --no-flush-rx
 
+Notes
+^^^^^
+
+The network interface provided to the PMD should be up, PMD will return an error if interface is down,
+and PMD itself won't change the status of the external network interface.
+
 
 Rings-based PMD
 ~~~~~~~~~~~~~~~
-- 
2.14.3

Re: [dpdk-dev] [PATCH] doc: update pcap documentation

[Mcnamara, John]

> -----Original Message-----
> From: Yigit, Ferruh
> Sent: Tuesday, January 16, 2018 6:45 PM
> To: Richardson, Bruce <bruce.richardson@intel.com>; Mcnamara, John
> <john.mcnamara@intel.com>; Kovacevic, Marko <marko.kovacevic@intel.com>
> Cc: dev@dpdk.org; Yigit, Ferruh <ferruh.yigit@intel.com>; Varghese, Vipin
> <vipin.varghese@intel.com>; Glynn, Michael J <michael.j.glynn@intel.com>
> Subject: [PATCH] doc: update pcap documentation
> 
> Add note about PMD expects the network interfaces provided to be up,
> documented behavior to set expectations right.
> 
> Also added minor fix.
> 
>...
> 
> +Notes
> +^^^^^
> +
> +The network interface provided to the PMD should be up, PMD will return
> +an error if interface is down, and PMD itself won't change the status of
> the external network interface.

It would probably be a little better as an RST note directive, as used elsewhere
in the doc. Like this:

.. note::

   The network interface provided to the PMD should be up. The PMD will return
   an error if interface is down, and the PMD itself won't change the status
   of the external network interface.

But it isn't a big issue so:

Acked-by: John McNamara <john.mcnamara@intel.com>

[dpdk-dev] [PATCH v2] doc: update pcap documentation

[Ferruh Yigit]

Add note about PMD expects the network interfaces provided to be up,
documented behavior to set expectations right.

Also added minor fix.

Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
Acked-by: John McNamara <john.mcnamara@intel.com>
---
Cc: Vipin Varghese <vipin.varghese@intel.com>
Cc: Michael Glynn <michael.j.glynn@intel.com>

v2: Convert "notes" subsection to ..note:: format
---
 doc/guides/nics/pcap_ring.rst | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/doc/guides/nics/pcap_ring.rst b/doc/guides/nics/pcap_ring.rst
index de47f68cf..7fd063c94 100644
--- a/doc/guides/nics/pcap_ring.rst
+++ b/doc/guides/nics/pcap_ring.rst
@@ -5,7 +5,7 @@ Libpcap and Ring Based Poll Mode Drivers
 ========================================
 
 In addition to Poll Mode Drivers (PMDs) for physical and virtual hardware,
-the DPDK also includes two pure-software PMDs. These two drivers are:
+the DPDK also includes pure-software PMDs, two of these drivers are:
 
 *   A libpcap -based PMD (librte_pmd_pcap) that reads and writes packets using libpcap,
     - both from files on disk, as well as from physical NIC devices using standard Linux kernel drivers.
@@ -148,6 +148,12 @@ Otherwise, the first 512 packets from the input pcap file will be discarded by t
         --vdev 'net_pcap0,rx_pcap=file_rx.pcap,tx_pcap=file_tx.pcap' \
         -- --port-topology=chained --no-flush-rx
 
+.. note::
+
+   The network interface provided to the PMD should be up. The PMD will return
+   an error if interface is down, and the PMD itself won't change the status
+   of the external network interface.
+
 
 Rings-based PMD
 ~~~~~~~~~~~~~~~
-- 
2.14.3

Re: [dpdk-dev] [PATCH v2] doc: update pcap documentation

[Ferruh Yigit]

On 1/17/2018 6:30 PM, Ferruh Yigit wrote:
> Add note about PMD expects the network interfaces provided to be up,
> documented behavior to set expectations right.
> 
> Also added minor fix.
> 
> Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
> Acked-by: John McNamara <john.mcnamara@intel.com>

Applied to dpdk-next-net/master, thanks.