diff mbox

linux-generic: pktio: remove doxygen for unused socket_id parameter

Message ID 1468455796-6261-1-git-send-email-bill.fischofer@linaro.org
State Accepted
Commit e1502b233407b5dfaf530de5c3cf97a5c20ab92b
Headers show

Commit Message

Bill Fischofer July 14, 2016, 12:23 a.m. UTC
The ODP version of the _ring_create() routine does not use a socket_id
parameter, so remove the doxygen that refers to it to resolve Bug
https://bugs.linaro.org/show_bug.cgi?id=2413

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

---
 platform/linux-generic/include/odp_packet_io_ring_internal.h | 1 -
 1 file changed, 1 deletion(-)

-- 
2.7.4

Comments

Maxim Uvarov July 14, 2016, 8:33 p.m. UTC | #1
Merged,
Maxim.

On 07/14/16 03:23, Bill Fischofer wrote:
> The ODP version of the _ring_create() routine does not use a socket_id

> parameter, so remove the doxygen that refers to it to resolve Bug

> https://bugs.linaro.org/show_bug.cgi?id=2413

>

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

> ---

>   platform/linux-generic/include/odp_packet_io_ring_internal.h | 1 -

>   1 file changed, 1 deletion(-)

>

> diff --git a/platform/linux-generic/include/odp_packet_io_ring_internal.h b/platform/linux-generic/include/odp_packet_io_ring_internal.h

> index f1188c3..d044f93 100644

> --- a/platform/linux-generic/include/odp_packet_io_ring_internal.h

> +++ b/platform/linux-generic/include/odp_packet_io_ring_internal.h

> @@ -180,7 +180,6 @@ typedef struct _ring {

>    *   The name of the ring.

>    * @param count

>    *   The size of the ring (must be a power of 2).

> - * @param socket_id (dummy, not included : todo)

>    * @param flags

>    *   An OR of the following:

>    *    - RING_F_SP_ENQ: If this flag is set, the default behavior when
diff mbox

Patch

diff --git a/platform/linux-generic/include/odp_packet_io_ring_internal.h b/platform/linux-generic/include/odp_packet_io_ring_internal.h
index f1188c3..d044f93 100644
--- a/platform/linux-generic/include/odp_packet_io_ring_internal.h
+++ b/platform/linux-generic/include/odp_packet_io_ring_internal.h
@@ -180,7 +180,6 @@  typedef struct _ring {
  *   The name of the ring.
  * @param count
  *   The size of the ring (must be a power of 2).
- * @param socket_id (dummy, not included : todo)
  * @param flags
  *   An OR of the following:
  *    - RING_F_SP_ENQ: If this flag is set, the default behavior when