diff mbox

[API-NEXT,PATCHv2] api: pktio: Clarify doc on default pool usage on odp_pktio_open

Message ID 1429821419-11648-1-git-send-email-bill.fischofer@linaro.org
State Accepted
Commit db175f8d9e4b0fa3198936083426dcab570b9d20
Headers show

Commit Message

Bill Fischofer April 23, 2015, 8:36 p.m. UTC
Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org>
---

Changes for v2: Correct grammatical ambiguities throughout doc for
odp_pktio_open().

 include/odp/api/packet_io.h | 22 +++++++++++++++-------
 1 file changed, 15 insertions(+), 7 deletions(-)

Comments

Maxim Uvarov April 24, 2015, 10:54 a.m. UTC | #1
On 04/24/15 13:21, Savolainen, Petri (Nokia - FI/Espoo) wrote:
> This is not a v2, since the original patch was already merged. Also my patches change the same lines, so need to rebase this after those are merged.
>
> -Petri
Petri I will revert original patch and apply that v2. After merge back 
to master v1 and it's revert will be removed on rebase.

Will fix your lines if there will be any reject.

Maxim.

>> -----Original Message-----
>> From: lng-odp [mailto:lng-odp-bounces@lists.linaro.org] On Behalf Of ext
>> Bill Fischofer
>> Sent: Thursday, April 23, 2015 11:37 PM
>> To: lng-odp@lists.linaro.org
>> Subject: [lng-odp] [API-NEXT PATCHv2] api: pktio: Clarify doc on default
>> pool usage on odp_pktio_open
>>
>> Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org>
>> ---
>>
>> Changes for v2: Correct grammatical ambiguities throughout doc for
>> odp_pktio_open().
>>
>>   include/odp/api/packet_io.h | 22 +++++++++++++++-------
>>   1 file changed, 15 insertions(+), 7 deletions(-)
>>
>> diff --git a/include/odp/api/packet_io.h b/include/odp/api/packet_io.h
>> index 6d31aeb..89356a6 100644
>> --- a/include/odp/api/packet_io.h
>> +++ b/include/odp/api/packet_io.h
>> @@ -47,20 +47,28 @@ extern "C" {
>>   /**
>>    * Open an ODP packet IO instance
>>    *
>> - * Packet IO handles are single instance per device, attempts to open an
>> already
>> - * open device will fail, returning ODP_PKTIO_INVALID with errno set.
>> - * odp_pktio_lookup() may be used to obtain a handle to an already open
>> device.
>> + * Packet IO handles are a single instance per device. Attempts to open
>> an
>> + * already open device will fail, returning ODP_PKTIO_INVALID with errno
>> set.
>> + * odp_pktio_lookup() may be used to obtain a handle to an already open
>> + * device.
>>    *
>>    * @param dev    Packet IO device name
>> - * @param pool   Pool from which to allocate buffers for storing packets
>> + * @param pool   Default pool from which to allocate buffers for storing
>> packets
>>    *               received over this packet IO
>>    *
>>    * @return ODP packet IO handle
>>    * @retval ODP_PKTIO_INVALID on failure
>>    *
>> - * @note dev name loop is specially pktio reserved name for
>> - *	 device used for testing. Usually it's loop back
>> - *	 interface.
>> + * @note The device name "loop" is a reserved name for a loopback device
>> used
>> + *	 for testing purposes.
>> + *
>> + * @note Packets arriving via this interface assigned to a CoS by the
>> + *	 classifier are received into the pool associated with that CoS.
>> This
>> + *	 will occur either becuase this pktio is assigned a default CoS via
>> + *	 the odp_pktio_default_cos_set() routine, or because a matching PMR
>> + *	 assigned the packet to a specific CoS. The default pool specified
>> + *	 here is applicable only for those packets that are not assigned to
>> a
>> + *	 more specific CoS.
>>    */
>>   odp_pktio_t odp_pktio_open(const char *dev, odp_pool_t pool);
>>
>> --
>> 2.1.0
>>
>> _______________________________________________
>> lng-odp mailing list
>> lng-odp@lists.linaro.org
>> https://lists.linaro.org/mailman/listinfo/lng-odp
> _______________________________________________
> lng-odp mailing list
> lng-odp@lists.linaro.org
> https://lists.linaro.org/mailman/listinfo/lng-odp
Maxim Uvarov April 24, 2015, 11:51 a.m. UTC | #2
On 04/24/15 14:04, Savolainen, Petri (Nokia - FI/Espoo) wrote:
>
>> -----Original Message-----
>> From: lng-odp [mailto:lng-odp-bounces@lists.linaro.org] On Behalf Of ext
>> Maxim Uvarov
>> Sent: Friday, April 24, 2015 1:55 PM
>> To: lng-odp@lists.linaro.org
>> Subject: Re: [lng-odp] [API-NEXT PATCHv2] api: pktio: Clarify doc on
>> default pool usage on odp_pktio_open
>>
>> On 04/24/15 13:21, Savolainen, Petri (Nokia - FI/Espoo) wrote:
>>> This is not a v2, since the original patch was already merged. Also my
>> patches change the same lines, so need to rebase this after those are
>> merged.
>>> -Petri
>> Petri I will revert original patch and apply that v2. After merge back
>> to master v1 and it's revert will be removed on rebase.
>>
>> Will fix your lines if there will be any reject.
>>
>> Maxim.
> Is revert the right thing to do? Could you merge those two/three patches together during apply to mainline? E.g. my patches changes word "instance" -> "interface" and this text has "instance" still/again. There will be conflicts when "v2" is not based on my patches, which are based on "v1".
>
> -Petri
Yes, revert is ok for api-next,  but it's not needed for master. In 
master I prefer to have plain history without bunch of reverts and 
merges from different branches.  That will be usual git merge / rebase 
conflict and I will fix it on final rebase. I don't think that we can 
lost something.

Maxim.
Mike Holmes April 27, 2015, 2:16 p.m. UTC | #3
On 23 April 2015 at 16:36, Bill Fischofer <bill.fischofer@linaro.org> wrote:

> Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org>
>

Reviewed-by: Mike Holmes <mike.holmes@linaro.org>


> ---
>
> Changes for v2: Correct grammatical ambiguities throughout doc for
> odp_pktio_open().
>
>  include/odp/api/packet_io.h | 22 +++++++++++++++-------
>  1 file changed, 15 insertions(+), 7 deletions(-)
>
> diff --git a/include/odp/api/packet_io.h b/include/odp/api/packet_io.h
> index 6d31aeb..89356a6 100644
> --- a/include/odp/api/packet_io.h
> +++ b/include/odp/api/packet_io.h
> @@ -47,20 +47,28 @@ extern "C" {
>  /**
>   * Open an ODP packet IO instance
>   *
> - * Packet IO handles are single instance per device, attempts to open an
> already
> - * open device will fail, returning ODP_PKTIO_INVALID with errno set.
> - * odp_pktio_lookup() may be used to obtain a handle to an already open
> device.
> + * Packet IO handles are a single instance per device. Attempts to open an
> + * already open device will fail, returning ODP_PKTIO_INVALID with errno
> set.
> + * odp_pktio_lookup() may be used to obtain a handle to an already open
> + * device.
>   *
>   * @param dev    Packet IO device name
> - * @param pool   Pool from which to allocate buffers for storing packets
> + * @param pool   Default pool from which to allocate buffers for storing
> packets
>   *               received over this packet IO
>   *
>   * @return ODP packet IO handle
>   * @retval ODP_PKTIO_INVALID on failure
>   *
> - * @note dev name loop is specially pktio reserved name for
> - *      device used for testing. Usually it's loop back
> - *      interface.
> + * @note The device name "loop" is a reserved name for a loopback device
> used
> + *      for testing purposes.
> + *
> + * @note Packets arriving via this interface assigned to a CoS by the
> + *      classifier are received into the pool associated with that CoS.
> This
> + *      will occur either becuase this pktio is assigned a default CoS via
> + *      the odp_pktio_default_cos_set() routine, or because a matching PMR
> + *      assigned the packet to a specific CoS. The default pool specified
> + *      here is applicable only for those packets that are not assigned
> to a
> + *      more specific CoS.
>   */
>  odp_pktio_t odp_pktio_open(const char *dev, odp_pool_t pool);
>
> --
> 2.1.0
>
> _______________________________________________
> lng-odp mailing list
> lng-odp@lists.linaro.org
> https://lists.linaro.org/mailman/listinfo/lng-odp
>
Maxim Uvarov April 27, 2015, 2:25 p.m. UTC | #4
Merged to api-next with replacing v1.

Maxim.

On 04/27/15 17:16, Mike Holmes wrote:
>
>
> On 23 April 2015 at 16:36, Bill Fischofer <bill.fischofer@linaro.org 
> <mailto:bill.fischofer@linaro.org>> wrote:
>
>     Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org
>     <mailto:bill.fischofer@linaro.org>>
>
>
> Reviewed-by: Mike Holmes <mike.holmes@linaro.org 
> <mailto:mike.holmes@linaro.org>>
>
>     ---
>
>     Changes for v2: Correct grammatical ambiguities throughout doc for
>     odp_pktio_open().
>
>      include/odp/api/packet_io.h | 22 +++++++++++++++-------
>      1 file changed, 15 insertions(+), 7 deletions(-)
>
>     diff --git a/include/odp/api/packet_io.h b/include/odp/api/packet_io.h
>     index 6d31aeb..89356a6 100644
>     --- a/include/odp/api/packet_io.h
>     +++ b/include/odp/api/packet_io.h
>     @@ -47,20 +47,28 @@ extern "C" {
>      /**
>       * Open an ODP packet IO instance
>       *
>     - * Packet IO handles are single instance per device, attempts to
>     open an already
>     - * open device will fail, returning ODP_PKTIO_INVALID with errno set.
>     - * odp_pktio_lookup() may be used to obtain a handle to an
>     already open device.
>     + * Packet IO handles are a single instance per device. Attempts
>     to open an
>     + * already open device will fail, returning ODP_PKTIO_INVALID
>     with errno set.
>     + * odp_pktio_lookup() may be used to obtain a handle to an
>     already open
>     + * device.
>       *
>       * @param dev    Packet IO device name
>     - * @param pool   Pool from which to allocate buffers for storing
>     packets
>     + * @param pool   Default pool from which to allocate buffers for
>     storing packets
>       *               received over this packet IO
>       *
>       * @return ODP packet IO handle
>       * @retval ODP_PKTIO_INVALID on failure
>       *
>     - * @note dev name loop is specially pktio reserved name for
>     - *      device used for testing. Usually it's loop back
>     - *      interface.
>     + * @note The device name "loop" is a reserved name for a loopback
>     device used
>     + *      for testing purposes.
>     + *
>     + * @note Packets arriving via this interface assigned to a CoS by the
>     + *      classifier are received into the pool associated with
>     that CoS. This
>     + *      will occur either becuase this pktio is assigned a
>     default CoS via
>     + *      the odp_pktio_default_cos_set() routine, or because a
>     matching PMR
>     + *      assigned the packet to a specific CoS. The default pool
>     specified
>     + *      here is applicable only for those packets that are not
>     assigned to a
>     + *      more specific CoS.
>       */
>      odp_pktio_t odp_pktio_open(const char *dev, odp_pool_t pool);
>
>     --
>     2.1.0
>
>     _______________________________________________
>     lng-odp mailing list
>     lng-odp@lists.linaro.org <mailto:lng-odp@lists.linaro.org>
>     https://lists.linaro.org/mailman/listinfo/lng-odp
>
>
>
>
> -- 
> Mike Holmes
> Technical Manager - Linaro Networking Group
> Linaro.org <http://www.linaro.org/>***│ *Open source software for ARM SoCs
>
>
>
> _______________________________________________
> lng-odp mailing list
> lng-odp@lists.linaro.org
> https://lists.linaro.org/mailman/listinfo/lng-odp
diff mbox

Patch

diff --git a/include/odp/api/packet_io.h b/include/odp/api/packet_io.h
index 6d31aeb..89356a6 100644
--- a/include/odp/api/packet_io.h
+++ b/include/odp/api/packet_io.h
@@ -47,20 +47,28 @@  extern "C" {
 /**
  * Open an ODP packet IO instance
  *
- * Packet IO handles are single instance per device, attempts to open an already
- * open device will fail, returning ODP_PKTIO_INVALID with errno set.
- * odp_pktio_lookup() may be used to obtain a handle to an already open device.
+ * Packet IO handles are a single instance per device. Attempts to open an
+ * already open device will fail, returning ODP_PKTIO_INVALID with errno set.
+ * odp_pktio_lookup() may be used to obtain a handle to an already open
+ * device.
  *
  * @param dev    Packet IO device name
- * @param pool   Pool from which to allocate buffers for storing packets
+ * @param pool   Default pool from which to allocate buffers for storing packets
  *               received over this packet IO
  *
  * @return ODP packet IO handle
  * @retval ODP_PKTIO_INVALID on failure
  *
- * @note dev name loop is specially pktio reserved name for
- *	 device used for testing. Usually it's loop back
- *	 interface.
+ * @note The device name "loop" is a reserved name for a loopback device used
+ *	 for testing purposes.
+ *
+ * @note Packets arriving via this interface assigned to a CoS by the
+ *	 classifier are received into the pool associated with that CoS. This
+ *	 will occur either becuase this pktio is assigned a default CoS via
+ *	 the odp_pktio_default_cos_set() routine, or because a matching PMR
+ *	 assigned the packet to a specific CoS. The default pool specified
+ *	 here is applicable only for those packets that are not assigned to a
+ *	 more specific CoS.
  */
 odp_pktio_t odp_pktio_open(const char *dev, odp_pool_t pool);