[5/5] ethdev: remove full stop after short comments and references
Checks
Commit Message
Full stop at the end of short comment just make line longer. It
should be either everywhere or nowhere to be consistent.
Fixes: 9f3eb8826450 ("ethdev: hide eth dev related structures")
Signed-off-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
---
lib/ethdev/ethdev_driver.h | 68 +++++++++++++++++++-------------------
1 file changed, 34 insertions(+), 34 deletions(-)
@@ -42,23 +42,23 @@ struct rte_eth_rxtx_callback {
* process, while the actual configuration data for the device is shared.
*/
struct rte_eth_dev {
- eth_rx_burst_t rx_pkt_burst; /**< Pointer to PMD receive function. */
- eth_tx_burst_t tx_pkt_burst; /**< Pointer to PMD transmit function. */
+ eth_rx_burst_t rx_pkt_burst; /**< Pointer to PMD receive function */
+ eth_tx_burst_t tx_pkt_burst; /**< Pointer to PMD transmit function */
- /** Pointer to PMD transmit prepare function. */
+ /** Pointer to PMD transmit prepare function */
eth_tx_prep_t tx_pkt_prepare;
- /** Get the number of used Rx descriptors. */
+ /** Get the number of used Rx descriptors */
eth_rx_queue_count_t rx_queue_count;
- /** Check the status of a Rx descriptor. */
+ /** Check the status of a Rx descriptor */
eth_rx_descriptor_status_t rx_descriptor_status;
- /** Check the status of a Tx descriptor. */
+ /** Check the status of a Tx descriptor */
eth_tx_descriptor_status_t tx_descriptor_status;
/**
- * Device data that is shared between primary and secondary processes.
+ * Device data that is shared between primary and secondary processes
*/
struct rte_eth_dev_data *data;
- void *process_private; /**< Pointer to per-process device data. */
+ void *process_private; /**< Pointer to per-process device data */
const struct eth_dev_ops *dev_ops; /**< Functions exported by PMD */
struct rte_device *device; /**< Backing device */
struct rte_intr_handle *intr_handle; /**< Device interrupt handle */
@@ -72,7 +72,7 @@ struct rte_eth_dev {
struct rte_eth_rxtx_callback *post_rx_burst_cbs[RTE_MAX_QUEUES_PER_PORT];
/**
* User-supplied functions called from tx_burst to pre-process
- * received packets before passing them to the driver for transmission.
+ * received packets before passing them to the driver for transmission
*/
struct rte_eth_rxtx_callback *pre_tx_burst_cbs[RTE_MAX_QUEUES_PER_PORT];
@@ -92,28 +92,28 @@ struct rte_eth_dev_owner;
struct rte_eth_dev_data {
char name[RTE_ETH_NAME_MAX_LEN]; /**< Unique identifier name */
- void **rx_queues; /**< Array of pointers to Rx queues. */
- void **tx_queues; /**< Array of pointers to Tx queues. */
- uint16_t nb_rx_queues; /**< Number of Rx queues. */
- uint16_t nb_tx_queues; /**< Number of Tx queues. */
+ void **rx_queues; /**< Array of pointers to Rx queues */
+ void **tx_queues; /**< Array of pointers to Tx queues */
+ uint16_t nb_rx_queues; /**< Number of Rx queues */
+ uint16_t nb_tx_queues; /**< Number of Tx queues */
struct rte_eth_dev_sriov sriov; /**< SRIOV data */
- /** PMD-specific private data. @see rte_eth_dev_release_port(). */
+ /** PMD-specific private data. @see rte_eth_dev_release_port() */
void *dev_private;
- struct rte_eth_link dev_link; /**< Link-level information & status. */
- struct rte_eth_conf dev_conf; /**< Configuration applied to device. */
- uint16_t mtu; /**< Maximum Transmission Unit. */
+ struct rte_eth_link dev_link; /**< Link-level information & status */
+ struct rte_eth_conf dev_conf; /**< Configuration applied to device */
+ uint16_t mtu; /**< Maximum Transmission Unit */
- /** Common Rx buffer size handled by all queues. */
+ /** Common Rx buffer size handled by all queues */
uint32_t min_rx_buf_size;
- uint64_t rx_mbuf_alloc_failed; /**< Rx ring mbuf allocation failures. */
+ uint64_t rx_mbuf_alloc_failed; /**< Rx ring mbuf allocation failures */
- /** Device Ethernet link address. @see rte_eth_dev_release_port(). */
+ /** Device Ethernet link address. @see rte_eth_dev_release_port() */
struct rte_ether_addr *mac_addrs;
- /** Bitmap associating MAC addresses to pools. */
+ /** Bitmap associating MAC addresses to pools */
uint64_t mac_pool_sel[ETH_NUM_RECEIVE_MAC_ADDR];
/**
* Device Ethernet MAC addresses of hash filtering.
@@ -121,37 +121,37 @@ struct rte_eth_dev_data {
*/
struct rte_ether_addr *hash_mac_addrs;
- uint16_t port_id; /**< Device [external] port identifier. */
+ uint16_t port_id; /**< Device [external] port identifier */
__extension__
- uint8_t /** Rx promiscuous mode ON(1) / OFF(0). */
+ uint8_t /** Rx promiscuous mode ON(1) / OFF(0) */
promiscuous : 1,
/** Rx of scattered packets is ON(1) / OFF(0) */
scattered_rx : 1,
- /** Rx all multicast mode ON(1) / OFF(0). */
+ /** Rx all multicast mode ON(1) / OFF(0) */
all_multicast : 1,
- /** Device state: STARTED(1) / STOPPED(0). */
+ /** Device state: STARTED(1) / STOPPED(0) */
dev_started : 1,
/** Rx LRO is ON(1) / OFF(0) */
lro : 1,
/**
- * Indicates whether the device is configured.
- * CONFIGURED(1) / NOT CONFIGURED(0).
+ * Indicates whether the device is configured:
+ * CONFIGURED(1) / NOT CONFIGURED(0)
*/
dev_configured : 1;
- /** Queues state: HAIRPIN(2) / STARTED(1) / STOPPED(0). */
+ /** Queues state: HAIRPIN(2) / STARTED(1) / STOPPED(0) */
uint8_t rx_queue_state[RTE_MAX_QUEUES_PER_PORT];
- /** Queues state: HAIRPIN(2) / STARTED(1) / STOPPED(0). */
+ /** Queues state: HAIRPIN(2) / STARTED(1) / STOPPED(0) */
uint8_t tx_queue_state[RTE_MAX_QUEUES_PER_PORT];
- uint32_t dev_flags; /**< Capabilities. */
- int numa_node; /**< NUMA node connection. */
+ uint32_t dev_flags; /**< Capabilities */
+ int numa_node; /**< NUMA node connection */
- /** VLAN filter configuration. */
+ /** VLAN filter configuration */
struct rte_vlan_filter_conf vlan_filter_conf;
- struct rte_eth_dev_owner owner; /**< The port owner. */
+ struct rte_eth_dev_owner owner; /**< The port owner */
/**
* Switch-specific identifier.
@@ -165,7 +165,7 @@ struct rte_eth_dev_data {
*/
uint16_t backer_port_id;
- pthread_mutex_t flow_ops_mutex; /**< rte_flow ops mutex. */
+ pthread_mutex_t flow_ops_mutex; /**< rte_flow ops mutex */
} __rte_cache_aligned;
/**