diff mbox

[1/2] api: correct inconsistent spelling of metadata

Message ID 1419353188-17440-1-git-send-email-anders.roxell@linaro.org
State Accepted
Commit d0ce1949042c950283f0490aab0de7772a7d8fc3
Headers show

Commit Message

Anders Roxell Dec. 23, 2014, 4:46 p.m. UTC
Signed-off-by: Anders Roxell <anders.roxell@linaro.org>
---
 platform/linux-generic/include/api/odp_classification.h |  2 +-
 platform/linux-generic/include/api/odp_packet.h         | 16 ++++++++--------
 2 files changed, 9 insertions(+), 9 deletions(-)

Comments

Bill Fischofer Dec. 23, 2014, 6:29 p.m. UTC | #1
On Tue, Dec 23, 2014 at 10:46 AM, Anders Roxell <anders.roxell@linaro.org>
wrote:
>
> Signed-off-by: Anders Roxell <anders.roxell@linaro.org>
>

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


> ---
>  platform/linux-generic/include/api/odp_classification.h |  2 +-
>  platform/linux-generic/include/api/odp_packet.h         | 16
> ++++++++--------
>  2 files changed, 9 insertions(+), 9 deletions(-)
>
> diff --git a/platform/linux-generic/include/api/odp_classification.h
> b/platform/linux-generic/include/api/odp_classification.h
> index 64ad73f..4c9674b 100644
> --- a/platform/linux-generic/include/api/odp_classification.h
> +++ b/platform/linux-generic/include/api/odp_classification.h
> @@ -37,7 +37,7 @@ typedef uint32_t odp_cos_t;
>
>
>  /**
> - * flow signature type, only used for packet meta data field.
> + * flow signature type, only used for packet metadata field.
>   */
>  typedef uint32_t odp_flowsig_t;
>
> diff --git a/platform/linux-generic/include/api/odp_packet.h
> b/platform/linux-generic/include/api/odp_packet.h
> index 8a1d917..920a593 100644
> --- a/platform/linux-generic/include/api/odp_packet.h
> +++ b/platform/linux-generic/include/api/odp_packet.h
> @@ -34,7 +34,7 @@ extern "C" {
>   * - Segment data length must be always at least one byte (i.e. there are
> no
>   *   empty segments)
>   * - Head/tailroom content belong to packet content (in addition to data
> - *   and meta-data) and thus is preserved over packet ownership changes.
> + *   and metadata) and thus is preserved over packet ownership changes.
>   * - _addr refer to a fixed address, which operations do not modify
>   * - _ptr refer to pointer to data, which may be modified by operations
>   */
> @@ -80,7 +80,7 @@ void odp_packet_free(odp_packet_t pkt);
>  /**
>   * Reset packet
>   *
> - * Resets all packet meta-data to their default values. Packet length is
> used
> + * Resets all packet metadata to their default values. Packet length is
> used
>   * to initialize pointers and lengths. It must be less than the total
> buffer
>   * length of the packet minus the default headroom length. Packet is not
>   * modified on failure.
> @@ -245,7 +245,7 @@ void *odp_packet_tail(odp_packet_t pkt);
>   * data     -= len
>   *
>   * Operation does not modify packet segmentation or move data. Handles and
> - * pointers remain valid. User is responsible to update packet meta-data
> + * pointers remain valid. User is responsible to update packet metadata
>   * offsets when needed.
>   *
>   * @param pkt  Packet handle
> @@ -273,7 +273,7 @@ void *odp_packet_push_head(odp_packet_t pkt, uint32_t
> len);
>   * data     += len
>   *
>   * Operation does not modify packet segmentation or move data. Handles and
> - * pointers remain valid. User is responsible to update packet meta-data
> + * pointers remain valid. User is responsible to update packet metadata
>   * offsets when needed.
>   *
>   * @param pkt  Packet handle
> @@ -332,7 +332,7 @@ void *odp_packet_push_tail(odp_packet_t pkt, uint32_t
> len);
>   * tailroom += len
>   *
>   * Operation does not modify packet segmentation or move data. Handles and
> - * pointers remain valid. User is responsible to update packet meta-data
> + * pointers remain valid. User is responsible to update packet metadata
>   * offsets when needed.
>   *
>   * @param pkt  Packet handle
> @@ -728,7 +728,7 @@ uint32_t odp_packet_seg_data_len(odp_packet_t pkt,
> odp_packet_seg_t seg);
>   * Increases packet data length by adding new data area into the specified
>   * offset. The operation returns a new packet handle on success. It may
> modify
>   * packet segmentation and move data. Handles and pointers must be updated
> - * after the operation. User is responsible to update packet meta-data
> offsets
> + * after the operation. User is responsible to update packet metadata
> offsets
>   * when needed. The packet is not modified on an error.
>   *
>   * @param pkt     Packet handle
> @@ -746,7 +746,7 @@ odp_packet_t odp_packet_add_data(odp_packet_t pkt,
> uint32_t offset,
>   * Decreases packet data length by removing data from the specified
> offset.
>   * The operation returns a new packet handle on success, and may modify
>   * packet segmentation and move data. Handles and pointers must be updated
> - * after the operation. User is responsible to update packet meta-data
> offsets
> + * after the operation. User is responsible to update packet metadata
> offsets
>   * when needed. The packet is not modified on an error.
>   *
>   * @param pkt     Packet handle
> @@ -770,7 +770,7 @@ odp_packet_t odp_packet_rem_data(odp_packet_t pkt,
> uint32_t offset,
>   * Copy packet
>   *
>   * Create a new copy of the packet. The new packet is exact copy of the
> source
> - * packet (incl. data and meta-data). The pool must have been created with
> + * packet (incl. data and metadata). The pool must have been created with
>   * buffer type ODP_BUFFER_TYPE_PACKET.
>   *
>   * @param pkt   Packet handle
> --
> 2.1.0
>
>
> _______________________________________________
> lng-odp mailing list
> lng-odp@lists.linaro.org
> http://lists.linaro.org/mailman/listinfo/lng-odp
>
Maxim Uvarov Dec. 24, 2014, 2:14 p.m. UTC | #2
Merged,
Maxim.

On 12/23/2014 07:46 PM, Anders Roxell wrote:
> Signed-off-by: Anders Roxell <anders.roxell@linaro.org>
> ---
>   platform/linux-generic/include/api/odp_classification.h |  2 +-
>   platform/linux-generic/include/api/odp_packet.h         | 16 ++++++++--------
>   2 files changed, 9 insertions(+), 9 deletions(-)
>
> diff --git a/platform/linux-generic/include/api/odp_classification.h b/platform/linux-generic/include/api/odp_classification.h
> index 64ad73f..4c9674b 100644
> --- a/platform/linux-generic/include/api/odp_classification.h
> +++ b/platform/linux-generic/include/api/odp_classification.h
> @@ -37,7 +37,7 @@ typedef uint32_t odp_cos_t;
>   
>   
>   /**
> - * flow signature type, only used for packet meta data field.
> + * flow signature type, only used for packet metadata field.
>    */
>   typedef uint32_t odp_flowsig_t;
>   
> diff --git a/platform/linux-generic/include/api/odp_packet.h b/platform/linux-generic/include/api/odp_packet.h
> index 8a1d917..920a593 100644
> --- a/platform/linux-generic/include/api/odp_packet.h
> +++ b/platform/linux-generic/include/api/odp_packet.h
> @@ -34,7 +34,7 @@ extern "C" {
>    * - Segment data length must be always at least one byte (i.e. there are no
>    *   empty segments)
>    * - Head/tailroom content belong to packet content (in addition to data
> - *   and meta-data) and thus is preserved over packet ownership changes.
> + *   and metadata) and thus is preserved over packet ownership changes.
>    * - _addr refer to a fixed address, which operations do not modify
>    * - _ptr refer to pointer to data, which may be modified by operations
>    */
> @@ -80,7 +80,7 @@ void odp_packet_free(odp_packet_t pkt);
>   /**
>    * Reset packet
>    *
> - * Resets all packet meta-data to their default values. Packet length is used
> + * Resets all packet metadata to their default values. Packet length is used
>    * to initialize pointers and lengths. It must be less than the total buffer
>    * length of the packet minus the default headroom length. Packet is not
>    * modified on failure.
> @@ -245,7 +245,7 @@ void *odp_packet_tail(odp_packet_t pkt);
>    * data     -= len
>    *
>    * Operation does not modify packet segmentation or move data. Handles and
> - * pointers remain valid. User is responsible to update packet meta-data
> + * pointers remain valid. User is responsible to update packet metadata
>    * offsets when needed.
>    *
>    * @param pkt  Packet handle
> @@ -273,7 +273,7 @@ void *odp_packet_push_head(odp_packet_t pkt, uint32_t len);
>    * data     += len
>    *
>    * Operation does not modify packet segmentation or move data. Handles and
> - * pointers remain valid. User is responsible to update packet meta-data
> + * pointers remain valid. User is responsible to update packet metadata
>    * offsets when needed.
>    *
>    * @param pkt  Packet handle
> @@ -332,7 +332,7 @@ void *odp_packet_push_tail(odp_packet_t pkt, uint32_t len);
>    * tailroom += len
>    *
>    * Operation does not modify packet segmentation or move data. Handles and
> - * pointers remain valid. User is responsible to update packet meta-data
> + * pointers remain valid. User is responsible to update packet metadata
>    * offsets when needed.
>    *
>    * @param pkt  Packet handle
> @@ -728,7 +728,7 @@ uint32_t odp_packet_seg_data_len(odp_packet_t pkt, odp_packet_seg_t seg);
>    * Increases packet data length by adding new data area into the specified
>    * offset. The operation returns a new packet handle on success. It may modify
>    * packet segmentation and move data. Handles and pointers must be updated
> - * after the operation. User is responsible to update packet meta-data offsets
> + * after the operation. User is responsible to update packet metadata offsets
>    * when needed. The packet is not modified on an error.
>    *
>    * @param pkt     Packet handle
> @@ -746,7 +746,7 @@ odp_packet_t odp_packet_add_data(odp_packet_t pkt, uint32_t offset,
>    * Decreases packet data length by removing data from the specified offset.
>    * The operation returns a new packet handle on success, and may modify
>    * packet segmentation and move data. Handles and pointers must be updated
> - * after the operation. User is responsible to update packet meta-data offsets
> + * after the operation. User is responsible to update packet metadata offsets
>    * when needed. The packet is not modified on an error.
>    *
>    * @param pkt     Packet handle
> @@ -770,7 +770,7 @@ odp_packet_t odp_packet_rem_data(odp_packet_t pkt, uint32_t offset,
>    * Copy packet
>    *
>    * Create a new copy of the packet. The new packet is exact copy of the source
> - * packet (incl. data and meta-data). The pool must have been created with
> + * packet (incl. data and metadata). The pool must have been created with
>    * buffer type ODP_BUFFER_TYPE_PACKET.
>    *
>    * @param pkt   Packet handle
diff mbox

Patch

diff --git a/platform/linux-generic/include/api/odp_classification.h b/platform/linux-generic/include/api/odp_classification.h
index 64ad73f..4c9674b 100644
--- a/platform/linux-generic/include/api/odp_classification.h
+++ b/platform/linux-generic/include/api/odp_classification.h
@@ -37,7 +37,7 @@  typedef uint32_t odp_cos_t;
 
 
 /**
- * flow signature type, only used for packet meta data field.
+ * flow signature type, only used for packet metadata field.
  */
 typedef uint32_t odp_flowsig_t;
 
diff --git a/platform/linux-generic/include/api/odp_packet.h b/platform/linux-generic/include/api/odp_packet.h
index 8a1d917..920a593 100644
--- a/platform/linux-generic/include/api/odp_packet.h
+++ b/platform/linux-generic/include/api/odp_packet.h
@@ -34,7 +34,7 @@  extern "C" {
  * - Segment data length must be always at least one byte (i.e. there are no
  *   empty segments)
  * - Head/tailroom content belong to packet content (in addition to data
- *   and meta-data) and thus is preserved over packet ownership changes.
+ *   and metadata) and thus is preserved over packet ownership changes.
  * - _addr refer to a fixed address, which operations do not modify
  * - _ptr refer to pointer to data, which may be modified by operations
  */
@@ -80,7 +80,7 @@  void odp_packet_free(odp_packet_t pkt);
 /**
  * Reset packet
  *
- * Resets all packet meta-data to their default values. Packet length is used
+ * Resets all packet metadata to their default values. Packet length is used
  * to initialize pointers and lengths. It must be less than the total buffer
  * length of the packet minus the default headroom length. Packet is not
  * modified on failure.
@@ -245,7 +245,7 @@  void *odp_packet_tail(odp_packet_t pkt);
  * data     -= len
  *
  * Operation does not modify packet segmentation or move data. Handles and
- * pointers remain valid. User is responsible to update packet meta-data
+ * pointers remain valid. User is responsible to update packet metadata
  * offsets when needed.
  *
  * @param pkt  Packet handle
@@ -273,7 +273,7 @@  void *odp_packet_push_head(odp_packet_t pkt, uint32_t len);
  * data     += len
  *
  * Operation does not modify packet segmentation or move data. Handles and
- * pointers remain valid. User is responsible to update packet meta-data
+ * pointers remain valid. User is responsible to update packet metadata
  * offsets when needed.
  *
  * @param pkt  Packet handle
@@ -332,7 +332,7 @@  void *odp_packet_push_tail(odp_packet_t pkt, uint32_t len);
  * tailroom += len
  *
  * Operation does not modify packet segmentation or move data. Handles and
- * pointers remain valid. User is responsible to update packet meta-data
+ * pointers remain valid. User is responsible to update packet metadata
  * offsets when needed.
  *
  * @param pkt  Packet handle
@@ -728,7 +728,7 @@  uint32_t odp_packet_seg_data_len(odp_packet_t pkt, odp_packet_seg_t seg);
  * Increases packet data length by adding new data area into the specified
  * offset. The operation returns a new packet handle on success. It may modify
  * packet segmentation and move data. Handles and pointers must be updated
- * after the operation. User is responsible to update packet meta-data offsets
+ * after the operation. User is responsible to update packet metadata offsets
  * when needed. The packet is not modified on an error.
  *
  * @param pkt     Packet handle
@@ -746,7 +746,7 @@  odp_packet_t odp_packet_add_data(odp_packet_t pkt, uint32_t offset,
  * Decreases packet data length by removing data from the specified offset.
  * The operation returns a new packet handle on success, and may modify
  * packet segmentation and move data. Handles and pointers must be updated
- * after the operation. User is responsible to update packet meta-data offsets
+ * after the operation. User is responsible to update packet metadata offsets
  * when needed. The packet is not modified on an error.
  *
  * @param pkt     Packet handle
@@ -770,7 +770,7 @@  odp_packet_t odp_packet_rem_data(odp_packet_t pkt, uint32_t offset,
  * Copy packet
  *
  * Create a new copy of the packet. The new packet is exact copy of the source
- * packet (incl. data and meta-data). The pool must have been created with
+ * packet (incl. data and metadata). The pool must have been created with
  * buffer type ODP_BUFFER_TYPE_PACKET.
  *
  * @param pkt   Packet handle