From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail-wm0-f66.google.com (mail-wm0-f66.google.com [74.125.82.66]) by dpdk.org (Postfix) with ESMTP id EEE9C1B1D0 for ; Fri, 16 Feb 2018 15:26:45 +0100 (CET) Received: by mail-wm0-f66.google.com with SMTP id x4so5748204wmc.0 for ; Fri, 16 Feb 2018 06:26:45 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=6wind-com.20150623.gappssmtp.com; s=20150623; h=date:from:to:cc:subject:message-id:references:mime-version :content-disposition:in-reply-to; bh=hsTXtXc5yMjdeFsesH5LswRBP/8fi/gp1hgHavkJZog=; b=IpSlIfPMHmchRClxiPlfykKVIuQZIHUGthfwRkzjnMUZGIjFu+rXnDjBB0z0Ww71Sc OZn/o3uLiYooOb37497X5TS8ofMf0jTPYoR0FtYhrf5Qwa/8QDO4lKZZLgENRzI6siuw tTtwu37YqGaxpiXquJ4Ci4e4eIJjIyuGz1IAXirFqwZvQ36B0ia+04Z1/0vYe2PSPUYg 7gFsFblqEMk6l/t510NL+mICjdp9pdGe0AjW8+kogKE3XxVDUFDJXAeBPAnZzEZsG0Kf IVgpRXSZ5AF5uKoDQhK9KpY4VrwVGai7UsNAFGHcwtO1VlCdfrhqT+BBf2kupevJOfDJ +Ehw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:date:from:to:cc:subject:message-id:references :mime-version:content-disposition:in-reply-to; bh=hsTXtXc5yMjdeFsesH5LswRBP/8fi/gp1hgHavkJZog=; b=QsnqVDqLG9U7q1XXCcFArlcIjO9cBhnpfzbL6X+1rIB1cYHviFPZovJ6qs+FuGbegK 7h9zJmftkAcnGN077abRok5UcbcXyIRCRC184hog46DsVaAf+4vG/6v2hqkJb2r1ONzl pNwj7HJlzEFJ5aM4HvbO0R5DqDbFRGmi05v52RXiLMFI2m/fEjtighOWzkp2UdBJ2xXN bn88yS6SKU7J5yyl/wrAN2s1ybilrKDlyKwGybU4hBDOzb7lipYcyuxPMitIdIcFYQQc 8pnRprVfZIwGSgfTbVP57hzVISCPjdQMhuJ50HFhrlAG6/sRD8A8G9NYO6SWMs5Ok7Gv 7ACA== X-Gm-Message-State: APf1xPCrvcGSoxydlxtBb8zIAEOAISSEqxm69vAIQXnrsgxsZnytEtmS t/qfJMfP0WBcDVQpcVvyYyOX/A== X-Google-Smtp-Source: AH8x226beG05YwPxVpu5BmRu7RWnJIqSRjeQjGdtRNxAA3NCX8PwOEjHK0HLByqDYiII0SfIiLnYoA== X-Received: by 10.28.238.132 with SMTP id j4mr1956789wmi.73.1518791205608; Fri, 16 Feb 2018 06:26:45 -0800 (PST) Received: from 6wind.com (host.78.145.23.62.rev.coltfrance.com. [62.23.145.78]) by smtp.gmail.com with ESMTPSA id a53sm20997580wrc.52.2018.02.16.06.26.43 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Fri, 16 Feb 2018 06:26:44 -0800 (PST) Date: Fri, 16 Feb 2018 15:26:31 +0100 From: Adrien Mazarguil To: Nelio Laranjeiro Cc: dev@dpdk.org, Yongseok Koh Message-ID: <20180216142631.GE4256@6wind.com> References: MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: Subject: Re: [dpdk-dev] [PATCH 1/3] net/mlx5: add missing function documentation X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 16 Feb 2018 14:26:46 -0000 I hate to sound pedantic but... On Thu, Feb 15, 2018 at 10:29:25AM +0100, Nelio Laranjeiro wrote: > Signed-off-by: Nelio Laranjeiro > Acked-by: Yongseok Koh > --- > drivers/net/mlx5/mlx5_trigger.c | 30 ++++++++++++++++++++++++++++++ > 1 file changed, 30 insertions(+) > > diff --git a/drivers/net/mlx5/mlx5_trigger.c b/drivers/net/mlx5/mlx5_trigger.c > index f5711a998..a70b13d52 100644 > --- a/drivers/net/mlx5/mlx5_trigger.c > +++ b/drivers/net/mlx5/mlx5_trigger.c > @@ -14,6 +14,12 @@ > #include "mlx5_rxtx.h" > #include "mlx5_utils.h" > > +/** > + * Stop traffic on Tx queues. > + * > + * @param priv ...there's an extra space between @param and priv :) > + * Pointer to private structure. > + */ > static void > priv_txq_stop(struct priv *priv) > { > @@ -23,6 +29,15 @@ priv_txq_stop(struct priv *priv) > mlx5_priv_txq_release(priv, i); > } > > +/** > + * Start traffic on Tx queues. > + * > + * @param priv Ditto. > + * Pointer to private structure. > + * > + * @return > + * 0 on success, errno on error. This should more accurately read "0 on success, positive errno value otherwise". I would suggest to document these functions only after the errno mess is sorted (patch 2/3 should come first) for a smaller amount of changes. > + */ > static int > priv_txq_start(struct priv *priv) > { > @@ -58,6 +73,12 @@ priv_txq_start(struct priv *priv) > return ret; > } > > +/** > + * Stop traffic on Rx queues. > + * > + * @param priv Extra space here also. > + * Pointer to private structure. > + */ > static void > priv_rxq_stop(struct priv *priv) > { > @@ -67,6 +88,15 @@ priv_rxq_stop(struct priv *priv) > mlx5_priv_rxq_release(priv, i); > } > > +/** > + * Start traffic on Rx queues. > + * > + * @param priv Again. > + * Pointer to private structure. > + * > + * @return > + * 0 on success, errno on error. Ditto regarding errno sign. > + */ > static int > priv_rxq_start(struct priv *priv) > { > -- > 2.11.0 > There are other functions are not properly documented either, you might want to add them for consistency: mlx5_ethdev.c: - mlx5_dev_supported_ptypes_get (no documentation) - mlx5_link_update_unlocked_gset (return value) - mlx5_link_update_unlocked_gs (return value) - priv_link_update (return value) - mlx5_link_update (return value) mlx5_flow.c: - mlx5_flow_create_eth (return value) - mlx5_flow_create_vlan (return value) - mlx5_flow_create_ipv4 (return value) - mlx5_flow_create_ipv6 (return value) - mlx5_flow_create_udp (return value) - mlx5_flow_create_tcp (return value) - mlx5_flow_create_vxlan (return value) - mlx5_flow_create_flag_mark (return value) - priv_flow_create_drop_queue (return in case of error) - priv_flow_verify (inconsistent @return syntax) mlx5_glue.c: - mlx5_glue_* (too many of them and those are basic wrappers, don't bother) mlx5_mr.c: - priv_mr_verify (inconsistent @return syntax) mlx5_rxq.c: - mlx5_priv_rxq_ibv_verify (ditto) - mlx5_priv_rxq_verify (ditto) - mlx5_priv_ind_table_ibv_verify (ditto) - mlx5_priv_hrxq_ibv_verify (ditto) mlx5_rxtx.c: - mlx5_tx_burst_raw_vec - mlx5_tx_burst_vec - mlx5_rx_burst_vec - priv_check_raw_vec_tx_support - priv_check_vec_tx_support - rxq_check_vec_support - priv_check_vec_rx_support mlx5_trigger.c: - Those are taken care of by the current patch. mlx5_txq.c: - mlx5_priv_txq_ibv_verify (inconsistent @return syntax) - mlx5_priv_txq_verify (ditto) mlx5_vlan.c - mlx5_vlan_offload_set (return value) I think that's all. -- Adrien Mazarguil 6WIND