From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: <dev-bounces@dpdk.org> Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 3B5C8A034C; Wed, 22 Jun 2022 22:27:53 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id CD4ED4281C; Wed, 22 Jun 2022 22:27:47 +0200 (CEST) Received: from mail-pg1-f174.google.com (mail-pg1-f174.google.com [209.85.215.174]) by mails.dpdk.org (Postfix) with ESMTP id F32B44281B for <dev@dpdk.org>; Wed, 22 Jun 2022 22:27:44 +0200 (CEST) Received: by mail-pg1-f174.google.com with SMTP id d129so17114905pgc.9 for <dev@dpdk.org>; Wed, 22 Jun 2022 13:27:44 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=networkplumber-org.20210112.gappssmtp.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=kvAY0G3/9ZcZqtXBj86H9T8f/KlwhLBwhVTwnKT8ccQ=; b=EpeDHKQI4NsCxYx4YdzdSrz64qnPUVYVwQxtzVU7gZrsMUP6h14BKqKpJ/dEZr8bng T7WSBFG1JYpqE4PUeJv8lvLkMPMa7ZMFT0Zud0/UUJR6q0Qe7ZZnHfI4y2oAz5EPicYX MjCwadDcCJJwEAreSLN0MK7YutC1pvGYh87us+z+KSeRHA1d+vGbCoCRuB8zoeEfyC+I A0l00Qb0N2IWkTXO937QwjEryp7VYJrY6kXsZq0vyUyavdQOeTBKBqrxBIKCvv7X+uwQ 73J0sTz/kR/Hnxepqxiqx49I/jH9EZILHJyKiFdZH/ID8EJ1pSpp6uPgj0TuHAZ8kNpI Mo4w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=kvAY0G3/9ZcZqtXBj86H9T8f/KlwhLBwhVTwnKT8ccQ=; b=kvlFsUCU/sLLaoh4brhlUNEKXIDUi0i3rDpiptvBWpWdKHxEx2Z5EexExqLCoVVPrg neS9z2Z9ijmRe6pO+cKqlS5dir2o9LOnjAgalKRtkRqXWLhpqA4vDDiVnA9iFJT4jME7 XDwNhsS3RgfrOhIMlKKEOsu24OWF47rbF9bl4+WUxlv1GM5f5ramEvLWVDYbrS/lm8Jw eT+bf60pqw1HapLJUzimkBPHGlQg5N0YTL+kCKkHFvj41xwIgiEPjVKzAbDKsULhQzsi 1NxyY6eZnJPw6izooCk/oZhFvOB42iX7e6M1ANKGd4CJe4Z9Kf3jZIvEEr6YaUuZ1VGG H8ow== X-Gm-Message-State: AJIora+F23Wn7Cn3nNQa97gkvhMhgsfrIG47KQzIsdOF6hcfohXtJ5EC MgIwi6sM3rTsklAMZt4E/b5qdfBN/+MwL1Y8 X-Google-Smtp-Source: AGRyM1sAQKSoUkhYC9zKMxdex6aJ5Obu8UpL7alJE997UqX+lCroolRTGH9Hgl7qW2LywiaHMCnqBA== X-Received: by 2002:a05:6a00:805:b0:525:532c:6655 with SMTP id m5-20020a056a00080500b00525532c6655mr839950pfk.70.1655929663919; Wed, 22 Jun 2022 13:27:43 -0700 (PDT) Received: from hermes.local (204-195-112-199.wavecable.com. [204.195.112.199]) by smtp.gmail.com with ESMTPSA id p11-20020a170903248b00b00161ac982b52sm13244438plw.95.2022.06.22.13.27.43 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 22 Jun 2022 13:27:43 -0700 (PDT) From: Stephen Hemminger <stephen@networkplumber.org> To: dev@dpdk.org Cc: Stephen Hemminger <stephen@networkplumber.org>, Harman Kalra <hkalra@marvell.com> Subject: [PATCH 2/2] eal: remove passive voice from interrupt function documentation Date: Wed, 22 Jun 2022 13:27:38 -0700 Message-Id: <20220622202738.401690-3-stephen@networkplumber.org> X-Mailer: git-send-email 2.35.1 In-Reply-To: <20220622202738.401690-1-stephen@networkplumber.org> References: <20220622202738.401690-1-stephen@networkplumber.org> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions <dev.dpdk.org> List-Unsubscribe: <https://mails.dpdk.org/options/dev>, <mailto:dev-request@dpdk.org?subject=unsubscribe> List-Archive: <http://mails.dpdk.org/archives/dev/> List-Post: <mailto:dev@dpdk.org> List-Help: <mailto:dev-request@dpdk.org?subject=help> List-Subscribe: <https://mails.dpdk.org/listinfo/dev>, <mailto:dev-request@dpdk.org?subject=subscribe> Errors-To: dev-bounces@dpdk.org The phrase "This API is used" is unnecessary, remove it. Reword to describe function in active voice. Signed-off-by: Stephen Hemminger <stephen@networkplumber.org> --- lib/eal/include/rte_interrupts.h | 23 +++++++++++------------ 1 file changed, 11 insertions(+), 12 deletions(-) diff --git a/lib/eal/include/rte_interrupts.h b/lib/eal/include/rte_interrupts.h index edbf0faeeffd..68ad19c3e742 100644 --- a/lib/eal/include/rte_interrupts.h +++ b/lib/eal/include/rte_interrupts.h @@ -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. -- 2.35.1