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

Mcnamara, John john.mcnamara at intel.com
Wed Jan 17 17:35:24 CET 2018



> -----Original Message-----
> From: Yigit, Ferruh
> Sent: Tuesday, January 16, 2018 6:45 PM
> To: Richardson, Bruce <bruce.richardson at intel.com>; Mcnamara, John
> <john.mcnamara at intel.com>; Kovacevic, Marko <marko.kovacevic at intel.com>
> Cc: dev at dpdk.org; Yigit, Ferruh <ferruh.yigit at intel.com>; Varghese, Vipin
> <vipin.varghese at intel.com>; Glynn, Michael J <michael.j.glynn at 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 at intel.com>






More information about the dev mailing list