doc: fix spelling reported by aspell in comments

[ upstream commit 8bd5f07 ] Fix spelling errors in the doxygen docs. Signed-off-by: John McNamara <john.mcnamara@intel.com>
kevintraynor · May 8, 2019 · 5036b8b · 5036b8b
1 parent 8ca6a5b
commit 5036b8b
Show file tree

Hide file tree

Showing 50 changed files with 100 additions and 100 deletions.
diff --git a/drivers/event/opdl/opdl_ring.h b/drivers/event/opdl/opdl_ring.h
@@ -24,7 +24,7 @@
  * packets.
  *
  * A opdl_ring can be used as the basis for pipeline based applications. Instead
- * of each stage in a pipeline dequeueing from a ring, processing and enqueueing
+ * of each stage in a pipeline dequeuing from a ring, processing and enqueuing
  * to another ring, it can process entries in-place on the ring. If stages do
  * not depend on each other, they can run in parallel.
  *
@@ -152,7 +152,7 @@ opdl_ring_get_name(const struct opdl_ring *t);
  *   Enabling this may have a negative impact on performance if only one thread
  *   will be processing this stage.
  * @param is_input
- *   Indication to nitialise the stage with all slots available or none
+ *   Indication to initialise the stage with all slots available or none
  *
  * @return
  *   A pointer to the new stage, or NULL on error.
@@ -589,7 +589,7 @@ opdl_ring_set_stage_threadsafe(struct opdl_stage *s, bool threadsafe);
  * Compare the event descriptor with original version in the ring.
  * if key field event descriptor is changed by application, then
  * update the slot in the ring otherwise do nothing with it.
- * the key field is flow_id, prioirty, mbuf, impl_opaque
+ * the key field is flow_id, priority, mbuf, impl_opaque
  *
  * @param s
  *   The opdl_stage.
@@ -600,7 +600,7 @@ opdl_ring_set_stage_threadsafe(struct opdl_stage *s, bool threadsafe);
  * @param atomic
  *   queue type associate with the stage.
  * @return
- *   if the evevnt key field is changed compare with previous record.
+ *   if the event key field is changed compare with previous record.
  */
 
 bool

diff --git a/drivers/net/i40e/rte_pmd_i40e.h b/drivers/net/i40e/rte_pmd_i40e.h
@@ -270,7 +270,7 @@ struct rte_pmd_i40e_pkt_template_action {
 struct rte_pmd_i40e_pkt_template_input {
 	/** the pctype used for raw packet template */
 	uint16_t pctype;
-	/** the buffer conatining raw packet template */
+	/** the buffer containing raw packet template */
 	void *packet;
 	/** the length of buffer with raw packet template */
 	uint32_t length;
@@ -314,7 +314,7 @@ struct rte_pmd_i40e_inset {
  * @param conf
  *   Specifies configuration parameters of raw packet template filter.
  * @param add
- *   Speicifes an action to be taken - add or remove raw packet template filter.
+ *   Specifies an action to be taken - add or remove raw packet template filter.
  * @return
  *   - (0) if successful.
  *   - (-ENODEV) if *port* invalid.

diff --git a/drivers/net/nfp/nfp_net.c b/drivers/net/nfp/nfp_net.c
@@ -761,7 +761,7 @@ nfp_net_start(struct rte_eth_dev *dev)
 		return -EIO;
 
 	/*
-	 * Allocating rte mbuffs for configured rx queues.
+	 * Allocating rte mbufs for configured rx queues.
 	 * This requires queues being enabled before
 	 */
 	if (nfp_net_rx_freelist_setup(dev) < 0) {
@@ -1490,7 +1490,7 @@ nfp_net_rx_queue_setup(struct rte_eth_dev *dev,
 	if (rxq == NULL)
 		return -ENOMEM;
 
-	/* Hw queues mapping based on firmware confifguration */
+	/* Hw queues mapping based on firmware configuration */
 	rxq->qidx = queue_idx;
 	rxq->fl_qcidx = queue_idx * hw->stride_rx;
 	rxq->rx_qcidx = rxq->fl_qcidx + (hw->stride_rx - 1);
@@ -1522,7 +1522,7 @@ nfp_net_rx_queue_setup(struct rte_eth_dev *dev,
 				   socket_id);
 
 	if (tz == NULL) {
-		PMD_DRV_LOG(ERR, "Error allocatig rx dma");
+		PMD_DRV_LOG(ERR, "Error allocating rx dma");
 		nfp_net_rx_queue_release(rxq);
 		return -ENOMEM;
 	}
@@ -1909,7 +1909,7 @@ nfp_net_mbuf_alloc_failed(struct nfp_net_rxq *rxq)
 /*
  * RX path design:
  *
- * There are some decissions to take:
+ * There are some decisions to take:
  * 1) How to check DD RX descriptors bit
  * 2) How and when to allocate new mbufs
  *
@@ -1979,7 +1979,7 @@ nfp_net_recv_pkts(void *rx_queue, struct rte_mbuf **rx_pkts, uint16_t nb_pkts)
 		rte_rmb();
 
 		/*
-		 * We got a packet. Let's alloc a new mbuff for refilling the
+		 * We got a packet. Let's alloc a new mbuf for refilling the
 		 * free descriptor ring as soon as possible
 		 */
 		new_mb = rte_pktmbuf_alloc(rxq->mem_pool);
@@ -1994,8 +1994,8 @@ nfp_net_recv_pkts(void *rx_queue, struct rte_mbuf **rx_pkts, uint16_t nb_pkts)
 		nb_hold++;
 
 		/*
-		 * Grab the mbuff and refill the descriptor with the
-		 * previously allocated mbuff
+		 * Grab the mbuf and refill the descriptor with the
+		 * previously allocated mbuf
 		 */
 		mb = rxb->mbuf;
 		rxb->mbuf = new_mb;
@@ -2027,7 +2027,7 @@ nfp_net_recv_pkts(void *rx_queue, struct rte_mbuf **rx_pkts, uint16_t nb_pkts)
 			return -EINVAL;
 		}
 
-		/* Filling the received mbuff with packet info */
+		/* Filling the received mbuf with packet info */
 		if (hw->rx_offset)
 			mb->data_off = RTE_PKTMBUF_HEADROOM + hw->rx_offset;
 		else
@@ -2052,7 +2052,7 @@ nfp_net_recv_pkts(void *rx_queue, struct rte_mbuf **rx_pkts, uint16_t nb_pkts)
 			mb->ol_flags |= PKT_RX_VLAN | PKT_RX_VLAN_STRIPPED;
 		}
 
-		/* Adding the mbuff to the mbuff array passed by the app */
+		/* Adding the mbuf to the mbuf array passed by the app */
 		rx_pkts[avail++] = mb;
 
 		/* Now resetting and updating the descriptor */

diff --git a/drivers/net/nfp/nfp_net_pmd.h b/drivers/net/nfp/nfp_net_pmd.h
@@ -34,7 +34,7 @@
  *
  * @file dpdk/pmd/nfp_net_pmd.h
  *
- * Netronome NFP_NET PDM driver
+ * Netronome NFP_NET PMD driver
  */
 
 #ifndef _NFP_NET_PMD_H_
@@ -240,7 +240,7 @@ struct nfp_net_txq {
 	uint32_t tx_free_thresh;
 
 	/*
-	 * For each descriptor keep a reference to the mbuff and
+	 * For each descriptor keep a reference to the mbuf and
 	 * DMA address used until completion is signalled.
 	 */
 	struct {

diff --git a/drivers/raw/dpaa2_qdma/rte_pmd_dpaa2_qdma.h b/drivers/raw/dpaa2_qdma/rte_pmd_dpaa2_qdma.h
@@ -31,7 +31,7 @@ enum {
 };
 
 /**
- * If user has configued a Virtual Queue mode, but for some particular VQ
+ * If user has configured a Virtual Queue mode, but for some particular VQ
  * user needs an exclusive H/W queue associated (for better performance
  * on that particular VQ), then user can pass this flag while creating the
  * Virtual Queue. A H/W queue will be allocated corresponding to
@@ -262,7 +262,7 @@ rte_qdma_vq_stats(uint16_t vq_id,
  * VQ's at runtime.
  *
  * @param vq_id
- *   Virtual Queue ID which needs to be deinialized.
+ *   Virtual Queue ID which needs to be uninitialized.
  *
  * @returns
  *   - 0: Success.

diff --git a/examples/performance-thread/common/lthread_api.h b/examples/performance-thread/common/lthread_api.h
@@ -206,12 +206,12 @@ void lthread_run(void);
   *  Creates an lthread and places it in the ready queue on a particular
   *  lcore.
   *
-  *  If no scheduler exists yet on the curret lcore then one is created.
+  *  If no scheduler exists yet on the current lcore then one is created.
   *
   * @param new_lt
   *  Pointer to an lthread pointer that will be initialized
   * @param lcore
-  *  the lcore the thread should be started on or the current clore
+  *  the lcore the thread should be started on or the current lcore
   *    -1 the current lcore
   *    0 - LTHREAD_MAX_LCORES any other lcore
   * @param lthread_func
@@ -469,7 +469,7 @@ void
 /**
   * Set lthread TLS
   *
-  *  This function is modelled on pthread_set_sepcific()
+  *  This function is modelled on pthread_set_specific()
   *  It associates a thread-specific value with a key obtained via a previous
   *  call to lthread_key_create().
   *  Different threads may bind different values to the same key. These values
@@ -749,7 +749,7 @@ int lthread_cond_wait(struct lthread_cond *c, uint64_t reserved);
   * Signal a condition variable
   *
   *  The function unblocks one thread waiting for the condition variable cond.
-  *  If no threads are waiting on cond, the rte_lthead_cond_signal() function
+  *  If no threads are waiting on cond, the rte_lthread_cond_signal() function
   *  has no effect.
   *
   * @param cond
@@ -765,7 +765,7 @@ int lthread_cond_signal(struct lthread_cond *c);
   * Broadcast a condition variable
   *
   *  The function unblocks all threads waiting for the condition variable cond.
-  *  If no threads are waiting on cond, the rte_lthead_cond_broadcast()
+  *  If no threads are waiting on cond, the rte_lathed_cond_broadcast()
   *  function has no effect.
   *
   * @param cond

diff --git a/lib/librte_acl/acl_vect.h b/lib/librte_acl/acl_vect.h
@@ -17,7 +17,7 @@ extern "C" {
 
 
 /*
- * Takes 2 SIMD registers containing N transitions eachi (tr0, tr1).
+ * Takes 2 SIMD registers containing N transitions each (tr0, tr1).
  * Shuffles it into different representation:
  * lo - contains low 32 bits of given N transitions.
  * hi - contains high 32 bits of given N transitions.
@@ -66,7 +66,7 @@ extern "C" {
 								\
 	dfa_ofs = _##P##_sub_epi32(t, r);			\
 								\
-	/* QUAD/SINGLE caluclations. */				\
+	/* QUAD/SINGLE calculations. */				\
 	t = _##P##_cmpgt_epi8(in, tr_hi);			\
 	t = _##P##_sign_epi8(t, t);				\
 	t = _##P##_maddubs_epi16(t, t);				\

diff --git a/lib/librte_bbdev/rte_bbdev.h b/lib/librte_bbdev/rte_bbdev.h
@@ -43,7 +43,7 @@ extern "C" {
 #define RTE_BBDEV_MAX_DEVS 128  /**< Max number of devices */
 #endif
 
-/** Flags indiciate current state of BBDEV device */
+/** Flags indicate current state of BBDEV device */
 enum rte_bbdev_state {
 	RTE_BBDEV_UNUSED,
 	RTE_BBDEV_INITIALIZED
@@ -161,7 +161,7 @@ rte_bbdev_queue_configure(uint16_t dev_id, uint16_t queue_id,
 
 /**
  * Start a device.
- * This is the last step needed before enqueueing operations is possible.
+ * This is the last step needed before enqueuing operations is possible.
  *
  * @param dev_id
  *   The identifier of the device.

diff --git a/lib/librte_bpf/rte_bpf.h b/lib/librte_bpf/rte_bpf.h
@@ -120,7 +120,7 @@ rte_bpf_destroy(struct rte_bpf *bpf);
  * Create a new eBPF execution context and load given BPF code into it.
  *
  * @param prm
- *  Parameters used to create and initialise the BPF exeution context.
+ *  Parameters used to create and initialise the BPF execution context.
  * @return
  *   BPF handle that is used in future BPF operations,
  *   or NULL on error, with error code set in rte_errno.
@@ -136,7 +136,7 @@ rte_bpf_load(const struct rte_bpf_prm *prm);
  * file into it.
  *
  * @param prm
- *  Parameters used to create and initialise the BPF exeution context.
+ *  Parameters used to create and initialise the BPF execution context.
  * @param fname
  *  Pathname for a ELF file.
  * @param sname
@@ -183,7 +183,7 @@ rte_bpf_exec_burst(const struct rte_bpf *bpf, void *ctx[], uint64_t rc[],
 		uint32_t num);
 
 /**
- * Provide information about natively compield code for given BPF handle.
+ * Provide information about natively compiled code for given BPF handle.
  *
  * @param bpf
  *   handle for the BPF code.

diff --git a/lib/librte_bpf/rte_bpf_ethdev.h b/lib/librte_bpf/rte_bpf_ethdev.h
@@ -73,7 +73,7 @@ rte_bpf_eth_tx_unload(uint16_t port, uint16_t queue);
  * @param sname
  *  Name of the executable section within the file to load.
  * @param prm
- *  Parameters used to create and initialise the BPF exeution context.
+ *  Parameters used to create and initialise the BPF execution context.
  * @param flags
  *  Flags that define expected behavior of the loaded filter
  *  (i.e. jited/non-jited version to use).
@@ -98,7 +98,7 @@ rte_bpf_eth_rx_elf_load(uint16_t port, uint16_t queue,
  * @param sname
  *  Name of the executable section within the file to load.
  * @param prm
- *  Parameters used to create and initialise the BPF exeution context.
+ *  Parameters used to create and initialise the BPF execution context.
  * @param flags
  *  Flags that define expected expected behavior of the loaded filter
  *  (i.e. jited/non-jited version to use).

diff --git a/lib/librte_cryptodev/rte_crypto_asym.h b/lib/librte_cryptodev/rte_crypto_asym.h
@@ -112,15 +112,15 @@ enum rte_crypto_rsa_padding_type {
 	/**< RSA no padding scheme */
 	RTE_CRYPTO_RSA_PKCS1_V1_5_BT0,
 	/**< RSA PKCS#1 V1.5 Block Type 0 padding scheme
-	 * as descibed in rfc2313
+	 * as described in rfc2313
 	 */
 	RTE_CRYPTO_RSA_PKCS1_V1_5_BT1,
 	/**< RSA PKCS#1 V1.5 Block Type 01 padding scheme
-	 * as descibed in rfc2313
+	 * as described in rfc2313
 	 */
 	RTE_CRYPTO_RSA_PKCS1_V1_5_BT2,
 	/**< RSA PKCS#1 V1.5 Block Type 02 padding scheme
-	 * as descibed in rfc2313
+	 * as described in rfc2313
 	 */
 	RTE_CRYPTO_RSA_PADDING_OAEP,
 	/**< RSA PKCS#1 OAEP padding scheme */
@@ -227,7 +227,7 @@ struct rte_crypto_rsa_xform {
 /**
  * Asymmetric Modular exponentiation transform data
  *
- * Structure describing modular exponentation xform param
+ * Structure describing modular exponentiation xform param
  *
  */
 struct rte_crypto_modex_xform {
@@ -271,7 +271,7 @@ struct rte_crypto_dh_xform {
 
 	rte_crypto_param p;
 	/**< p : Prime modulus data
-	 * DH prime modulous data in octet-string network byte order format.
+	 * DH prime modulus data in octet-string network byte order format.
 	 *
 	 */
 

diff --git a/lib/librte_cryptodev/rte_cryptodev.h b/lib/librte_cryptodev/rte_cryptodev.h
@@ -1097,7 +1097,7 @@ rte_cryptodev_asym_session_clear(uint8_t dev_id,
  * Get the size of the header session, for all registered drivers.
  *
  * @return
- *   Size of the symmetric eader session.
+ *   Size of the symmetric header session.
  */
 unsigned int
 rte_cryptodev_sym_get_header_session_size(void);

diff --git a/lib/librte_distributor/rte_distributor_private.h b/lib/librte_distributor/rte_distributor_private.h
@@ -41,7 +41,7 @@ extern "C" {
 
 /**
  * Maximum number of workers allowed.
- * Be aware of increasing the limit, becaus it is limited by how we track
+ * Be aware of increasing the limit, because it is limited by how we track
  * in-flight tags. See in_flight_bitmask and rte_distributor_process
  */
 #define RTE_DISTRIB_MAX_WORKERS 64

diff --git a/lib/librte_eal/common/include/generic/rte_cycles.h b/lib/librte_eal/common/include/generic/rte_cycles.h
@@ -173,7 +173,7 @@ rte_delay_us_sleep(unsigned int us);
  *
  * @param userfunc
  *   User function which replaces rte_delay_us. rte_delay_us_block restores
- *   buildin block delay function.
+ *   builtin block delay function.
  */
 void rte_delay_us_callback_register(void(*userfunc)(unsigned int));
 

diff --git a/lib/librte_eal/common/include/rte_class.h b/lib/librte_eal/common/include/rte_class.h
@@ -15,7 +15,7 @@
  *
  * A device class defines the type of function a device
  * will be used for e.g.: Ethernet adapter (eth),
- * cryptographic coprocessor (crypto), etc.
+ * cryptographic co-processor (crypto), etc.
  */
 
 #ifdef __cplusplus

diff --git a/lib/librte_eal/common/include/rte_common.h b/lib/librte_eal/common/include/rte_common.h
@@ -340,7 +340,7 @@ rte_is_power_of_2(uint32_t n)
  * Aligns input parameter to the next power of 2
  *
  * @param x
- *   The integer value to algin
+ *   The integer value to align
  *
  * @return
  *   Input parameter aligned to the next power of 2
@@ -358,7 +358,7 @@ rte_align32pow2(uint32_t x)
  * Aligns input parameter to the previous power of 2
  *
  * @param x
- *   The integer value to algin
+ *   The integer value to align
  *
  * @return
  *   Input parameter aligned to the previous power of 2

diff --git a/lib/librte_eal/common/include/rte_eal.h b/lib/librte_eal/common/include/rte_eal.h
@@ -287,7 +287,7 @@ rte_mp_action_unregister(const char *name);
  *
  * Send a message to the peer process.
  *
- * This function will send a message which will be responsed by the action
+ * This function will send a message which will be responded by the action
  * identified by name in the peer process.
  *
  * @param msg
@@ -424,7 +424,7 @@ rte_set_application_usage_hook(rte_usage_hook_t usage_func);
 #define RTE_EAL_TAILQ_RWLOCK         (&rte_eal_get_configuration()->mem_config->qlock)
 
 /**
- * macro to get the multiple lock of mempool shared by mutiple-instance
+ * macro to get the multiple lock of mempool shared by multiple-instance
  */
 #define RTE_EAL_MEMPOOL_RWLOCK            (&rte_eal_get_configuration()->mem_config->mplock)