d/numam-dpdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

remove passive voice in function description

Browse Source 
Remove extraneous phrase "This API is used to" and use
active instead of passive voice when describing a function.

Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
Acked-by: Tyler Retzlaff <roretzla@linux.microsoft.com>
[David: for raw/ioat and dmadev parts:]
Acked-by: Chengwen Feng <fengchengwen@huawei.com>
Acked-by: Conor Walsh <conor.walsh@intel.com>
This commit is contained in:
Stephen Hemminger 2022-06-22 13:27:37 -07:00 committed by David Marchand
parent 261d96b29e
commit cb68a56343
3 changed files with 13 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
drivers/raw/ioat/rte_ioat_rawdev.h
View File

@ -123,7 +123,7 @@ rte_ioat_fence(int dev_id);
/**
* Trigger hardware to begin performing enqueued operations
*
* This API is used to write the "doorbell" to the hardware to trigger it
* Writes the "doorbell" to the hardware to trigger it
* to begin the operations previously enqueued by rte_ioat_enqueue_copy()
*
* @param dev_id

2
lib/dmadev/rte_dmadev.h
View File

@ -970,7 +970,7 @@ rte_dma_fill(int16_t dev_id, uint16_t vchan, uint64_t pattern,
*
* Trigger hardware to begin performing enqueued operations.
*
* This API is used to write the "doorbell" to the hardware to trigger it
* Writes the "doorbell" to the hardware to trigger it
* to begin the operations previously enqueued by rte_dma_copy/fill().
*
* @param dev_id

23
lib/eal/include/rte_interrupts.h
View File

@ -239,8 +239,7 @@ rte_intr_instance_alloc(uint32_t flags);
* @warning
* @b EXPERIMENTAL: this API may change without prior notice
*
* This API is used to free the memory allocated for interrupt handle
* resources.
* Free the memory allocated for interrupt handle resources.
*
* @param intr_handle
* Interrupt handle address.
@ -254,7 +253,7 @@ rte_intr_instance_free(struct rte_intr_handle *intr_handle);
* @warning
* @b EXPERIMENTAL: this API may change without prior notice
*
* This API is used to set the fd field of interrupt handle with user provided
* Set the fd field of interrupt handle with user provided
* file descriptor.
*
* @param intr_handle
@ -291,7 +290,7 @@ rte_intr_fd_get(const struct rte_intr_handle *intr_handle);
* @warning
* @b EXPERIMENTAL: this API may change without prior notice
*
* This API is used to set the type field of interrupt handle with user provided
* Set the type field of interrupt handle with user provided
* interrupt type.
*
* @param intr_handle
@ -452,7 +451,7 @@ rte_intr_instance_dup(const struct rte_intr_handle *src);
/**
* @internal
* This API is used to set the device fd field of interrupt handle with user
* Set the device fd field of interrupt handle with user
* provided dev fd. Device fd corresponds to VFIO device fd or UIO config fd.
*
* @param intr_handle
@ -485,7 +484,7 @@ rte_intr_dev_fd_get(const struct rte_intr_handle *intr_handle);
/**
* @internal
* This API is used to set the max intr field of interrupt handle with user
* Set the max intr field of interrupt handle with user
* provided max intr value.
*
* @param intr_handle
@ -518,7 +517,7 @@ rte_intr_max_intr_get(const struct rte_intr_handle *intr_handle);
/**
* @internal
* This API is used to set the number of event fd field of interrupt handle
* Set the number of event fd field of interrupt handle
* with user provided available event file descriptor value.
*
* @param intr_handle
@ -572,7 +571,7 @@ rte_intr_nb_intr_get(const struct rte_intr_handle *intr_handle);
/**
* @internal
* This API is used to set the event fd counter size field of interrupt handle
* Set the event fd counter size field of interrupt handle
* with user provided efd counter size.
*
* @param intr_handle
@ -607,7 +606,7 @@ rte_intr_efd_counter_size_get(const struct rte_intr_handle *intr_handle);
/**
* @internal
* This API is used to set the event fd array index with the given fd.
* Set the event fd array index with the given fd.
*
* @param intr_handle
* pointer to the interrupt handle.
@ -643,7 +642,7 @@ rte_intr_efds_index_get(const struct rte_intr_handle *intr_handle, int index);
/**
* @internal
* This API is used to set the epoll event object array index with the given
* Set the epoll event object array index with the given
* elist instance.
*
* @param intr_handle
@ -779,7 +778,7 @@ rte_intr_event_list_update(struct rte_intr_handle *intr_handle, int size);
/**
* @internal
* This API returns the Windows handle of the given interrupt instance.
* Returns the Windows handle of the given interrupt instance.
*
* @param intr_handle
* pointer to the interrupt handle.
@ -794,7 +793,7 @@ rte_intr_instance_windows_handle_get(struct rte_intr_handle *intr_handle);
/**
* @internal
* This API set the Windows handle for the given interrupt instance.
* Set the Windows handle for the given interrupt instance.
*
* @param intr_handle
* pointer to the interrupt handle.