From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dispatch1-us1.ppe-hosted.com (dispatch1-us1.ppe-hosted.com [67.231.154.164]) by dpdk.org (Postfix) with ESMTP id 29D495F51 for ; Tue, 9 Oct 2018 11:42:33 +0200 (CEST) X-Virus-Scanned: Proofpoint Essentials engine Received: from webmail.solarflare.com (uk.solarflare.com [193.34.186.16]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-SHA384 (256/256 bits)) (No client certificate requested) by mx1-us1.ppe-hosted.com (Proofpoint Essentials ESMTP Server) with ESMTPS id 05809780059; Tue, 9 Oct 2018 09:42:32 +0000 (UTC) Received: from [192.168.38.17] (91.220.146.112) by ukex01.SolarFlarecom.com (10.17.10.4) with Microsoft SMTP Server (TLS) id 15.0.1395.4; Tue, 9 Oct 2018 10:42:26 +0100 To: Thomas Monjalon , CC: , , References: <20181007222554.4886-1-thomas@monjalon.net> <20181009001616.10497-1-thomas@monjalon.net> <20181009001616.10497-5-thomas@monjalon.net> From: Andrew Rybchenko Message-ID: <1c0a3ef1-24c3-a848-de48-2908feac8d18@solarflare.com> Date: Tue, 9 Oct 2018 12:41:45 +0300 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:60.0) Gecko/20100101 Thunderbird/60.0 MIME-Version: 1.0 In-Reply-To: <20181009001616.10497-5-thomas@monjalon.net> Content-Language: en-GB X-Originating-IP: [91.220.146.112] X-ClientProxiedBy: ocex03.SolarFlarecom.com (10.20.40.36) To ukex01.SolarFlarecom.com (10.17.10.4) X-TM-AS-Product-Ver: SMEX-12.5.0.1300-8.5.1010-24144.003 X-TM-AS-Result: No-11.110200-8.000000-10 X-TMASE-MatchedRID: X4bcv0S75KkOwH4pD14DsPHkpkyUphL9f6/Md8Lb2l9XA7rTaHAw72Bt 5R7lQ74qVmprnFvwtvKwiqg6QcdK56Y9mmoRUoWzdARARTk4h59MkOX0Uoduudvpj5+dNlQvVhb DEH23DROuhfDso3p5ET+Y4Ojh3fJRfalnNvZDQnzJ1E39jKDimBb6RqpiFT/zIFBEE5CFomIgv6 PTRzFRWnW1YXJLtmY6JFhwJyCl9Ze1DfGM6db7X4oLoibgjVEXlIvcAfYJnErHlpI5kmk0Q/NO7 flRFqXmIGSHKu90xKWSU848M/hs6Me4Woyb+kVFyDp+jSvEtWsl3afZehJEWedlU2K5Jm9bggBA sUW5uWTOH38lNbOoTFxI2ZZX9m4X319rGX8jiaGeAiCmPx4NwLTrdaH1ZWqC1B0Hk1Q1KyLUZxE AlFPo80ESKBlicakM2RWosx8CmguG+tlVXFs7pd19osEXlLSH7vD/cPM+eh+K4RaRLgg5Nq5/Vq qR7lbHswP0YRrockGyCmzFel9FRJknDxsRxTk+ X-TM-AS-User-Approved-Sender: Yes X-TM-AS-User-Blocked-Sender: No X-TMASE-Result: 10--11.110200-8.000000 X-TMASE-Version: SMEX-12.5.0.1300-8.5.1010-24144.003 X-MDID: 1539078152-dEj1HtAN4EVV Content-Type: text/plain; charset="utf-8"; format=flowed Content-Transfer-Encoding: 7bit X-Content-Filtered-By: Mailman/MimeDel 2.1.15 Subject: Re: [dpdk-dev] [PATCH v2 4/6] doc: replace doxygen example in contribution guide 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: Tue, 09 Oct 2018 09:42:33 -0000 On 10/9/18 3:16 AM, Thomas Monjalon wrote: > The provided example of doxygen header is about a deprecated function. > It is replaced by rte_spinlock_trylock() which is small and > good enough for the purpose. > > Signed-off-by: Thomas Monjalon One nit below Reviewed-by: Andrew Rybchenko > --- > doc/guides/contributing/documentation.rst | 15 +++++---------- > 1 file changed, 5 insertions(+), 10 deletions(-) > > diff --git a/doc/guides/contributing/documentation.rst b/doc/guides/contributing/documentation.rst > index 097575ad7..063c8b6c4 100644 > --- a/doc/guides/contributing/documentation.rst > +++ b/doc/guides/contributing/documentation.rst > @@ -615,19 +615,14 @@ The following are some guidelines for use of Doxygen in the DPDK API documentati > .. code-block:: c > > /** > - * Attach a new Ethernet device specified by arguments. > - * > - * @param devargs > - * A pointer to a strings array describing the new device > - * to be attached. The strings should be a pci address like > - * `0000:01:00.0` or **virtual** device name like `net_pcap0`. > - * @param port_id > - * A pointer to a port identifier actually attached. > + * Try to take the lock. > * > + * @param sl > + * A pointer to the spinlock. > * @return > - * 0 on success and port_id is filled, negative on error. > + * 1 if the lock is successfully taken; 0 otherwise. > */ > - int rte_eth_dev_attach(const char *devargs, uint8_t *port_id); > + int rte_spinlock_trylock (rte_spinlock_t *sl); Space is not required before ( and should be removed. > > * Doxygen supports Markdown style syntax such as bold, italics, fixed width text and lists. > For example the second line in the ``devargs`` parameter in the previous example will be rendered as: