From patchwork Thu Apr 28 06:39:03 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Elo, Matias \(Nokia - FI/Espoo\)" X-Patchwork-Id: 66855 Delivered-To: patch@linaro.org Received: by 10.140.93.198 with SMTP id d64csp41564qge; Wed, 27 Apr 2016 23:39:50 -0700 (PDT) X-Received: by 10.107.35.3 with SMTP id j3mr17491270ioj.119.1461825590897; Wed, 27 Apr 2016 23:39:50 -0700 (PDT) Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id 22si14896392ioj.205.2016.04.27.23.39.50; Wed, 27 Apr 2016 23:39:50 -0700 (PDT) Received-SPF: pass (google.com: domain of lng-odp-bounces@lists.linaro.org designates 54.225.227.206 as permitted sender) client-ip=54.225.227.206; Authentication-Results: mx.google.com; spf=pass (google.com: domain of lng-odp-bounces@lists.linaro.org designates 54.225.227.206 as permitted sender) smtp.mailfrom=lng-odp-bounces@lists.linaro.org; dmarc=fail (p=NONE dis=NONE) header.from=nokia.com Received: by lists.linaro.org (Postfix, from userid 109) id 681A36157A; Thu, 28 Apr 2016 06:39:50 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on ip-10-142-244-252 X-Spam-Level: X-Spam-Status: No, score=-6.9 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_HI, RCVD_IN_MSPIKE_H3, RCVD_IN_MSPIKE_WL, URIBL_BLOCKED autolearn=disabled version=3.4.0 Received: from [127.0.0.1] (localhost [127.0.0.1]) by lists.linaro.org (Postfix) with ESMTP id C73916157C; Thu, 28 Apr 2016 06:39:14 +0000 (UTC) X-Original-To: lng-odp@lists.linaro.org Delivered-To: lng-odp@lists.linaro.org Received: by lists.linaro.org (Postfix, from userid 109) id 31C5761579; Thu, 28 Apr 2016 06:39:10 +0000 (UTC) Received: from demumfd001.nsn-inter.net (demumfd001.nsn-inter.net [93.183.12.32]) by lists.linaro.org (Postfix) with ESMTPS id 85AB361570 for ; Thu, 28 Apr 2016 06:39:07 +0000 (UTC) Received: from demuprx017.emea.nsn-intra.net ([10.150.129.56]) by demumfd001.nsn-inter.net (8.15.2/8.15.2) with ESMTPS id u3S6d5kH012933 (version=TLSv1 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK) for ; Thu, 28 Apr 2016 06:39:05 GMT Received: from 10.144.19.15 ([10.144.104.109]) by demuprx017.emea.nsn-intra.net (8.12.11.20060308/8.12.11) with ESMTP id u3S6d4uH012081 (version=TLSv1/SSLv3 cipher=AES128-SHA bits=128 verify=NO) for ; Thu, 28 Apr 2016 08:39:05 +0200 From: Matias Elo To: lng-odp@lists.linaro.org Date: Thu, 28 Apr 2016 09:39:03 +0300 Message-Id: <1461825544-5360-1-git-send-email-matias.elo@nokia.com> X-Mailer: git-send-email 1.9.1 X-purgate-type: clean X-purgate-Ad: Categorized by eleven eXpurgate (R) http://www.eleven.de X-purgate: clean X-purgate: This mail is considered clean (visit http://www.eleven.de for further information) X-purgate-size: 21540 X-purgate-ID: 151667::1461825546-00001B3D-545A9D4E/0/0 X-Topics: patch Subject: [lng-odp] [API-NEXT PATCH v2 1/2] api: doc: fix typos X-BeenThere: lng-odp@lists.linaro.org X-Mailman-Version: 2.1.16 Precedence: list List-Id: "The OpenDataPlane \(ODP\) List" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Errors-To: lng-odp-bounces@lists.linaro.org Sender: "lng-odp" Signed-off-by: Matias Elo --- V2: + Rebased + Fixed more typos V1: Reviewed-by: Bill Fischofer include/odp/api/spec/atomic.h | 4 ++-- include/odp/api/spec/barrier.h | 2 +- include/odp/api/spec/buffer.h | 4 +++- include/odp/api/spec/classification.h | 8 ++++---- include/odp/api/spec/hints.h | 4 ++-- include/odp/api/spec/packet_io.h | 16 ++++++++-------- include/odp/api/spec/packet_io_stats.h | 4 ++-- include/odp/api/spec/queue.h | 12 ++++++------ include/odp/api/spec/rwlock.h | 2 +- include/odp/api/spec/schedule.h | 4 ++-- include/odp/api/spec/schedule_types.h | 4 ++-- include/odp/api/spec/traffic_mngr.h | 30 +++++++++++++++--------------- include/odp/api/spec/version.h | 2 +- 13 files changed, 49 insertions(+), 47 deletions(-) diff --git a/include/odp/api/spec/atomic.h b/include/odp/api/spec/atomic.h index 7638b93..36c50cb 100644 --- a/include/odp/api/spec/atomic.h +++ b/include/odp/api/spec/atomic.h @@ -116,7 +116,7 @@ void odp_atomic_add_u32(odp_atomic_u32_t *atom, uint32_t val); * Fetch and subtract from atomic uint32 variable * * @param atom Pointer to atomic variable - * @param val Value to be subracted from the variable + * @param val Value to be subtracted from the variable * * @return Value of the variable before the subtraction */ @@ -609,7 +609,7 @@ typedef union odp_atomic_op_t { * variables instead of uint64 to optimize performance on platforms that * implement a performance critical operation using locks. * - * Init operations (e.g. odp_atomic_init_64()) are not atomic. This function + * Init operations (e.g. odp_atomic_init_u64()) are not atomic. This function * clears the op.init bit but will never set it to one. * * @param atomic_op Pointer to atomic operation structure for storing diff --git a/include/odp/api/spec/barrier.h b/include/odp/api/spec/barrier.h index 01e3dc7..fbd1072 100644 --- a/include/odp/api/spec/barrier.h +++ b/include/odp/api/spec/barrier.h @@ -21,7 +21,7 @@ extern "C" { /** * @defgroup odp_barrier ODP BARRIER - * Thread excution and memory ordering barriers. + * Thread execution and memory ordering barriers. * * @details * Thread execution barrier (odp_barrier_t) diff --git a/include/odp/api/spec/buffer.h b/include/odp/api/spec/buffer.h index ddadc69..5c632b5 100644 --- a/include/odp/api/spec/buffer.h +++ b/include/odp/api/spec/buffer.h @@ -96,7 +96,9 @@ odp_pool_t odp_buffer_pool(odp_buffer_t buf); /** * Buffer alloc * - * The validity of a buffer can be cheked at any time with odp_buffer_is_valid() + * The validity of a buffer can be checked at any time with + * odp_buffer_is_valid(). + * * @param pool Pool handle * * @return Handle of allocated buffer diff --git a/include/odp/api/spec/classification.h b/include/odp/api/spec/classification.h index 1603d16..523a8c4 100644 --- a/include/odp/api/spec/classification.h +++ b/include/odp/api/spec/classification.h @@ -109,7 +109,7 @@ typedef union odp_cls_pmr_terms_t { /** * Classification capabilities - * This capability structure defines system level classfication capability + * This capability structure defines system level classification capability */ typedef struct odp_cls_capability_t { /** PMR terms supported by the classifier @@ -359,7 +359,7 @@ typedef enum { * Packet Matching Rule parameter structure */ typedef struct odp_pmr_param_t { - odp_cls_pmr_term_t term; /**< Packet Macthing Rule term */ + odp_cls_pmr_term_t term; /**< Packet Matching Rule term */ /** True if the value is range and false if match */ odp_bool_t range_term; @@ -389,7 +389,7 @@ typedef struct odp_pmr_param_t { } odp_pmr_param_t; /** - * Intiailize packet matching rule parameters + * Initialize packet matching rule parameters * * Initialize an odp_pmr_param_t to its default values for all fields * @@ -461,7 +461,7 @@ int odp_cls_cos_pool_set(odp_cos_t cos_id, odp_pool_t pool_id); * * @retval pool handle of the associated pool * @retval ODP_POOL_INVALID if no associated pool found or -* incase of an error +* in case of an error */ odp_pool_t odp_cls_cos_pool(odp_cos_t cos_id); diff --git a/include/odp/api/spec/hints.h b/include/odp/api/spec/hints.h index 158f802..ff5099c 100644 --- a/include/odp/api/spec/hints.h +++ b/include/odp/api/spec/hints.h @@ -26,7 +26,7 @@ extern "C" { #ifdef __GNUC__ -/** Define a fn that does not return +/** Define a function that does not return */ #define ODP_NORETURN __attribute__((__noreturn__)) @@ -57,7 +57,7 @@ extern "C" { #define ODP_DEPRECATED __attribute__((__deprecated__)) /** - * Intentionally unused variables ot functions + * Intentionally unused variables of functions */ #define ODP_UNUSED __attribute__((__unused__)) diff --git a/include/odp/api/spec/packet_io.h b/include/odp/api/spec/packet_io.h index cdfd637..c7373fd 100644 --- a/include/odp/api/spec/packet_io.h +++ b/include/odp/api/spec/packet_io.h @@ -134,16 +134,16 @@ typedef union odp_pktin_hash_proto_t { * Packet IO operation mode */ typedef enum odp_pktio_op_mode_t { - /** Multi-thread safe operation + /** Multithread safe operation * - * Direct packet IO operation (recv or send) is multi-thread safe. Any + * Direct packet IO operation (recv or send) is multithread safe. Any * number of application threads may perform the operation * concurrently. */ ODP_PKTIO_OP_MT = 0, - /** Not multi-thread safe operation + /** Not multithread safe operation * - * Direct packet IO operation (recv or send) may not be multi-thread + * Direct packet IO operation (recv or send) may not be multithread * safe. Application ensures synchronization between threads so that * simultaneously only single thread attempts the operation on * the same (pktin or pktout) queue. */ @@ -257,7 +257,7 @@ typedef struct odp_pktio_param_t { * enabled, implementation will verify checksum correctness on incoming packets * and depending on drop configuration either deliver erroneous packets with * appropriate flags set (e.g. odp_packet_has_l3_error()) or drop those. - * When packet droping is enabled, application will never receive a packet + * When packet dropping is enabled, application will never receive a packet * with the specified error and may avoid to check the error flag. */ typedef union odp_pktin_config_opt_t { @@ -693,7 +693,7 @@ int odp_pktio_stop(odp_pktio_t pktio); * Close a stopped packet IO interface. This call frees all remaining packets * stored in pktio receive and transmit side buffers. The pktio is destroyed * and the handle must not be used for other calls. After a successful call, - * the same pktio device can be opened again with a odp_packet_open() call. + * the same pktio device can be opened again with a odp_pktio_open() call. * * @param pktio Packet IO handle * @@ -765,7 +765,7 @@ int odp_pktin_recv_tmo(odp_pktin_queue_t queue, odp_packet_t packets[], * Receives up to 'num' packets from one of the specified pktio interface input * queues. The index of the source queue is stored into 'from' output * parameter. If there are no packets available on any of the queues, waits for - * packets depeding on 'wait' parameter value. Returns the number of packets + * packets depending on 'wait' parameter value. Returns the number of packets * received. * * When an input queue has been configured with 'op_mode' value @@ -957,7 +957,7 @@ int odp_pktio_index(odp_pktio_t pktio); uint64_t odp_pktio_to_u64(odp_pktio_t pktio); /** - * Intiailize pktio params + * Initialize pktio params * * Initialize an odp_pktio_param_t to its default values for all fields * diff --git a/include/odp/api/spec/packet_io_stats.h b/include/odp/api/spec/packet_io_stats.h index e0a6547..73cf704 100644 --- a/include/odp/api/spec/packet_io_stats.h +++ b/include/odp/api/spec/packet_io_stats.h @@ -25,7 +25,7 @@ extern "C" { /** * Packet IO statistics * - * Packet IO statictics counters follow RFCs for Management Information Base + * Packet IO statistics counters follow RFCs for Management Information Base * (MIB)for use with network management protocols in the Internet community: * https://tools.ietf.org/html/rfc3635 * https://tools.ietf.org/html/rfc2863 @@ -48,7 +48,7 @@ typedef struct odp_pktio_stats_t { /** * The number of inbound packets which were chosen to be discarded - * even though no errors had been detected to preven their being + * even though no errors had been detected to prevent their being * deliverable to a higher-layer protocol. One possible reason for * discarding such a packet could be to free up buffer space. * See ifInDiscards in RFC 2863. diff --git a/include/odp/api/spec/queue.h b/include/odp/api/spec/queue.h index e87df9f..92822da 100644 --- a/include/odp/api/spec/queue.h +++ b/include/odp/api/spec/queue.h @@ -69,16 +69,16 @@ typedef enum odp_queue_type_t { * Queue operation mode */ typedef enum odp_queue_op_mode_t { - /** Multi-thread safe operation + /** Multithread safe operation * - * Queue operation (enqueue or dequeue) is multi-thread safe. Any + * Queue operation (enqueue or dequeue) is multithread safe. Any * number of application threads may perform the operation * concurrently. */ ODP_QUEUE_OP_MT = 0, - /** Not multi-thread safe operation + /** Not multithread safe operation * - * Queue operation (enqueue or dequeue) may not be multi-thread safe. + * Queue operation (enqueue or dequeue) may not be multithread safe. * Application ensures synchronization between threads so that * simultaneously only single thread attempts the operation on * the same queue. */ @@ -128,14 +128,14 @@ typedef struct odp_queue_param_t { * * Default value for both queue types is ODP_QUEUE_OP_MT. Application * may enable performance optimizations by defining MT_UNSAFE or - * DISABLED modes when applicaple. */ + * DISABLED modes when applicable. */ odp_queue_op_mode_t enq_mode; /** Dequeue mode * * For PLAIN queues, the default value is ODP_QUEUE_OP_MT. Application * may enable performance optimizations by defining MT_UNSAFE or - * DISABLED modes when applicaple. However, when a plain queue is input + * DISABLED modes when applicable. However, when a plain queue is input * to the implementation (e.g. a queue for packet output), the * parameter is ignored in queue creation and the value is * ODP_QUEUE_OP_DISABLED. diff --git a/include/odp/api/spec/rwlock.h b/include/odp/api/spec/rwlock.h index 631df48..2624b56 100644 --- a/include/odp/api/spec/rwlock.h +++ b/include/odp/api/spec/rwlock.h @@ -25,7 +25,7 @@ extern "C" { * * A reader/writer lock allows multiple simultaneous readers but only one * writer at a time. A thread that wants write access will have to wait until - * there are no threads that want read access. This casues a risk for + * there are no threads that want read access. This causes a risk for * starvation. The trylock variants can be used to avoid blocking when * the lock is not immediately available. * @{ diff --git a/include/odp/api/spec/schedule.h b/include/odp/api/spec/schedule.h index 16d15d3..f8fed17 100644 --- a/include/odp/api/spec/schedule.h +++ b/include/odp/api/spec/schedule.h @@ -127,7 +127,7 @@ odp_event_t odp_schedule(odp_queue_t *from, uint64_t wait); * @param events Event array for output * @param num Maximum number of events to output * - * @return Number of events outputed (0 ... num) + * @return Number of events outputted (0 ... num) */ int odp_schedule_multi(odp_queue_t *from, uint64_t wait, odp_event_t events[], int num); @@ -259,7 +259,7 @@ odp_schedule_group_t odp_schedule_group_lookup(const char *name); * * Join a threadmask to an existing schedule group * - * @param group Schdule group handle + * @param group Schedule group handle * @param mask Thread mask * * @retval 0 on success diff --git a/include/odp/api/spec/schedule_types.h b/include/odp/api/spec/schedule_types.h index b394d53..b7c1980 100644 --- a/include/odp/api/spec/schedule_types.h +++ b/include/odp/api/spec/schedule_types.h @@ -45,7 +45,7 @@ extern "C" { /** * @def ODP_SCHED_PRIO_DEFAULT * Default scheduling priority. User does not care about the selected priority - * level - throughput, load balacing and synchronization features are more + * level - throughput, load balancing and synchronization features are more * important than priority scheduling. */ @@ -58,7 +58,7 @@ extern "C" { * @def ODP_SCHED_SYNC_PARALLEL * Parallel scheduled queues * - * The scheduler performs priority scheduling, load balancing, pre-fetching, etc + * The scheduler performs priority scheduling, load balancing, prefetching, etc * functions but does not provide additional event synchronization or ordering. * It's free to schedule events from single parallel queue to multiple threads * for concurrent processing. Application is responsible for queue context diff --git a/include/odp/api/spec/traffic_mngr.h b/include/odp/api/spec/traffic_mngr.h index fff4c46..c5b9d24 100644 --- a/include/odp/api/spec/traffic_mngr.h +++ b/include/odp/api/spec/traffic_mngr.h @@ -98,13 +98,13 @@ extern "C" { /** * @def ODP_TM_MIN_SHAPER_BW - * The largest amound of bandwidth that any shaper's peak or commit rate can + * The largest amount of bandwidth that any shaper's peak or commit rate can * be set to. It is in units of 1000 bytes/second. */ /** * @def ODP_TM_MAX_SHAPER_BW - * The largest amound of bandwidth that any shaper's peak or commit rate can + * The largest amount of bandwidth that any shaper's peak or commit rate can * be set to. It is in units of 1000 bytes/second. */ @@ -192,7 +192,7 @@ extern "C" { /** Per Level Capabilities * - * The odp_tm_level_capabilities_t record is used to describe the capabalities + * The odp_tm_level_capabilities_t record is used to describe the capabilities * that might vary based upon the tm_node level. It is always used as * part of the odp_tm_capabilities record. */ typedef struct { @@ -254,7 +254,7 @@ typedef struct { typedef struct { /** The name is an optional name associated with a capabilities * record. This name, if present, can be used by odp_tm_find to - * return a TM system matching this set of capabilitis. */ + * return a TM system matching this set of capabilities. */ char *name; /** max_tm_queues specifies the maximum number of tm_queues that can @@ -470,7 +470,7 @@ void odp_tm_egress_init(odp_tm_egress_t *egress); * TM limits supported by this implementation. The reason that this returns * a SET of capabilities and not just one, is because it is expected that * many HW based implementations may have one set of limits for the HW and - * also support a SW TM implementation with a (presumable larger) different + * also support a SW TM implementation with a (presumably larger) different * set of limits. There are also cases where there could be more than * SW implementation (one supporting say tens of thousands of tm_queues and * a variant supporting tens of millions of tm_queues). @@ -480,7 +480,7 @@ void odp_tm_egress_init(odp_tm_egress_t *egress); * that N is larger than the capabilities_size, N will still be returned, * but only capabilities_size records will be filled in. * - * @param[out] capabilities An arary of odp_tm_capabilities_t records to + * @param[out] capabilities An array of odp_tm_capabilities_t records to * be filled in. * @param[in] capabilities_size The number of odp_tm_capabilities_t records * in the capabilities array. @@ -520,7 +520,7 @@ odp_tm_t odp_tm_create(const char *name, * "HW_TM_%u" where the number starts at 1, can be used to find a built-in * system independently of the best requirements match. If name is NULL then * the existing (built-in or created by odp_tm_create) TM system that best - * matches the requirments is returned. + * matches the requirements is returned. * * @param[in] name If NULL then only uses the requirements parameter to * find a closest match, otherwise if the name is @@ -593,7 +593,7 @@ int odp_tm_destroy(odp_tm_t odp_tm); /** Vlan Marking. * - * The odp_tm_vlan__marking() function allows one to configure the TM egress + * The odp_tm_vlan_marking() function allows one to configure the TM egress * so as to have it set the one bit VLAN Drop Eligibility Indicator (DEI) * field (but only for pkts that already carry a VLAN tag) of a pkt based upon * the final pkt (or shaper?) color assigned to the pkt when it reaches the @@ -932,7 +932,7 @@ odp_tm_threshold_t odp_tm_threshold_create(const char *name, /** Destroy a queue threshold profile object * * The odp_tm_threshold_destroy() function destroys/frees the given threshold - * profile object. It is an error if this thresold profile is still being + * profile object. It is an error if this threshold profile is still being * referenced by an active (connected) tm_queue or tm_node. * * @param[in] threshold_profile Specifies the queue thresholds profile @@ -1129,7 +1129,7 @@ typedef struct { * the odp_tm_node_context() call. */ void *user_context; - /** The max_fan_in sets tha maximum number of src tm_queues and + /** The max_fanin sets the maximum number of src tm_queues and * producer tm_nodes that can be simultaneously be connected to this * tm_node as their destination. */ uint32_t max_fanin; @@ -1216,7 +1216,7 @@ int odp_tm_node_shaper_config(odp_tm_node_t tm_node, * @param[in] tm_node Specifies the tm_node to be changed. * @param[in] tm_fan_in_node Specifies which of the specified tm_node's * fan-in's weights etc are to be changed. The - * fan-in is indentified by the "producer"/parent + * fan-in is identified by the "producer"/parent * tm_node actually connected to this fan-in. * @param[in] sched_profile Specifies the scheduler profile that should * now be used for the WFQ/RR entity within the @@ -1406,7 +1406,7 @@ int odp_tm_queue_shaper_config(odp_tm_queue_t tm_queue, * @param[in] tm_node Specifies the tm_node to be changed. * @param[in] tm_fan_in_queue Specifies which of the specified tm_node's * fan-in's weights etc are to be changed. The - * fan-in is indentified by the "producer"/parent + * fan-in is identified by the "producer"/parent * tm_queue actually connected to this fan-in. * @param[in] sched_profile Specifies the scheduler profile that should * now be used for the WFQ/RR entity within the @@ -1481,7 +1481,7 @@ int odp_tm_node_connect(odp_tm_node_t src_tm_node, odp_tm_node_t dst_tm_node); */ int odp_tm_node_disconnect(odp_tm_node_t src_tm_node); -/** The odp_queue_connect() function connects the indicated tm_queue to a +/** The odp_tm_queue_connect() function connects the indicated tm_queue to a * parent tm_node or to the egress/root node. The tm_queue will then become * one of the dst node's fan-in set. * @@ -1523,7 +1523,7 @@ int odp_tm_queue_disconnect(odp_tm_queue_t tm_queue); * @param[in] tm_queue Specifies the tm_queue (and indirectly the TM system). * @param[in] pkt Handle to a packet. * @return Returns 0 upon success, < 0 upon failure. One of the - * more common failure reasons is WRED dropage. + * more common failure reasons is WRED drop. */ int odp_tm_enq(odp_tm_queue_t tm_queue, odp_packet_t pkt); @@ -1614,7 +1614,7 @@ typedef struct { /** Get tm_node Fanin Info * - * The odp_tm_node_fain_info() function is used to extract various bits of + * The odp_tm_node_fanin_info() function is used to extract various bits of * configuration associated with a given tm_node's fanin. It can also be * used to walk the complete fanin list of a given tm_node. Note in particular * that the odp_tm_node_fanin_info_t record passed to this function is both diff --git a/include/odp/api/spec/version.h b/include/odp/api/spec/version.h index a4d6818..7839b6e 100644 --- a/include/odp/api/spec/version.h +++ b/include/odp/api/spec/version.h @@ -24,7 +24,7 @@ extern "C" { * @details * ODP API and implementation versions * - * ODP API version is identified by ODP_VERSION_API_XXX pre-processor macros. + * ODP API version is identified by ODP_VERSION_API_XXX preprocessor macros. * In addition to these macros, API calls can be used to identify implementation * and API version information at run time. * @{