[dpdk-dev] [PATCH v2 4/6] doc: replace doxygen example in contribution guide

Andrew Rybchenko arybchenko at solarflare.com
Tue Oct 9 11:41:45 CEST 2018


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 <thomas at monjalon.net>

One nit below

Reviewed-by: Andrew Rybchenko <arybchenko at solarflare.com>

> ---
>   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:



More information about the dev mailing list