diff mbox

[API-NEXT,PATCHv2] api: pktio description of doxygen group

Message ID 1440766755-18405-1-git-send-email-maxim.uvarov@linaro.org
State Accepted
Commit 0a53c0546b82c8c2a11f97b9cb021ce8b0f72959
Headers show

Commit Message

Maxim Uvarov Aug. 28, 2015, 12:59 p.m. UTC
Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
---
 v2: more detailed description.

 include/odp/api/packet_io.h | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)

Comments

Maxim Uvarov Sept. 1, 2015, 1:51 p.m. UTC | #1
review, ping.

Maxim.

On 08/28/15 15:59, Maxim Uvarov wrote:
> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
> ---
>   v2: more detailed description.
>
>   include/odp/api/packet_io.h | 13 ++++++++++++-
>   1 file changed, 12 insertions(+), 1 deletion(-)
>
> diff --git a/include/odp/api/packet_io.h b/include/odp/api/packet_io.h
> index e00d011..aaa4e43 100644
> --- a/include/odp/api/packet_io.h
> +++ b/include/odp/api/packet_io.h
> @@ -19,7 +19,18 @@ extern "C" {
>   #endif
>   
>   /** @defgroup odp_packet_io ODP PACKET IO
> - *  Operations on a packet.
> + *  Operations on a packet Input/Output interface.
> + *
> + * Packet IO is the Ingress and Egress interface to ODP processing. It
> + * allows manipulation of the interface for setting such attributes as
> + * the mtu, mac etc.
> + * Pktio is usually followed by the classifier and a default class COS
> + * can be set so that the scheduler may distribute flows. The interface
> + * may be used directly in polled mode with odp_pktio_recv() &
> + * odp_pktio_send().
> + * Diagnostic massages can be enhanced by using odp_pktio_to_u64 which
> + * will generate a printable reference for a pktio handle for use with
> + * the logging @ref odp_ver_abt_log_dbg.
>    *  @{
>    */
>
Nicolas Morey-Chaisemartin Sept. 1, 2015, 2:14 p.m. UTC | #2
On 08/28/2015 02:59 PM, Maxim Uvarov wrote:
> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
> ---
>  v2: more detailed description.
>
>  include/odp/api/packet_io.h | 13 ++++++++++++-
>  1 file changed, 12 insertions(+), 1 deletion(-)
>
> diff --git a/include/odp/api/packet_io.h b/include/odp/api/packet_io.h
> index e00d011..aaa4e43 100644
> --- a/include/odp/api/packet_io.h
> +++ b/include/odp/api/packet_io.h
> @@ -19,7 +19,18 @@ extern "C" {
>  #endif
>  
>  /** @defgroup odp_packet_io ODP PACKET IO
> - *  Operations on a packet.
> + *  Operations on a packet Input/Output interface.
> + *
> + * Packet IO is the Ingress and Egress interface to ODP processing. It
> + * allows manipulation of the interface for setting such attributes as
> + * the mtu, mac etc.
> + * Pktio is usually followed by the classifier and a default class COS
> + * can be set so that the scheduler may distribute flows. The interface
> + * may be used directly in polled mode with odp_pktio_recv() &
> + * odp_pktio_send().
> + * Diagnostic massages can be enhanced by using odp_pktio_to_u64 which
I don't think we plan on mAssaging ODP users yet ;)

> + * will generate a printable reference for a pktio handle for use with
> + * the logging @ref odp_ver_abt_log_dbg.
>   *  @{
>   */
>  

Otherwise looks good.
Maxim Uvarov Sept. 3, 2015, 12:47 p.m. UTC | #3
On 09/01/15 17:14, Nicolas Morey-Chaisemartin wrote:
> Otherwise looks good.
will fix on apply. Can I set you review-by then?

Maxim.
Nicolas Morey-Chaisemartin Sept. 3, 2015, 12:48 p.m. UTC | #4
On 09/03/2015 02:47 PM, Maxim Uvarov wrote:
> On 09/01/15 17:14, Nicolas Morey-Chaisemartin wrote:
>> Otherwise looks good.
> will fix on apply. Can I set you review-by then?
>
> Maxim.
Yes.

Nicolas
Maxim Uvarov Sept. 3, 2015, 12:50 p.m. UTC | #5
Merged,
Maxim.

On 09/03/15 15:48, Nicolas Morey-Chaisemartin wrote:
>
> On 09/03/2015 02:47 PM, Maxim Uvarov wrote:
>> On 09/01/15 17:14, Nicolas Morey-Chaisemartin wrote:
>>> Otherwise looks good.
>> will fix on apply. Can I set you review-by then?
>>
>> Maxim.
> Yes.
>
> Nicolas
diff mbox

Patch

diff --git a/include/odp/api/packet_io.h b/include/odp/api/packet_io.h
index e00d011..aaa4e43 100644
--- a/include/odp/api/packet_io.h
+++ b/include/odp/api/packet_io.h
@@ -19,7 +19,18 @@  extern "C" {
 #endif
 
 /** @defgroup odp_packet_io ODP PACKET IO
- *  Operations on a packet.
+ *  Operations on a packet Input/Output interface.
+ *
+ * Packet IO is the Ingress and Egress interface to ODP processing. It
+ * allows manipulation of the interface for setting such attributes as
+ * the mtu, mac etc.
+ * Pktio is usually followed by the classifier and a default class COS
+ * can be set so that the scheduler may distribute flows. The interface
+ * may be used directly in polled mode with odp_pktio_recv() &
+ * odp_pktio_send().
+ * Diagnostic massages can be enhanced by using odp_pktio_to_u64 which
+ * will generate a printable reference for a pktio handle for use with
+ * the logging @ref odp_ver_abt_log_dbg.
  *  @{
  */