All of lore.kernel.org
 help / color / mirror / Atom feed
From: Leon Romanovsky <leon-DgEjT+Ai2ygdnm+yROfE0A@public.gmane.org>
To: Bart Van Assche <Bart.VanAssche-Sjgp3cTcYWE@public.gmane.org>
Cc: "jgg-VPRAkNaXOzVWk0Htik3J/w@public.gmane.org"
	<jgg-VPRAkNaXOzVWk0Htik3J/w@public.gmane.org>,
	"linux-rdma-u79uwXL29TY76Z2rM5mHXA@public.gmane.org"
	<linux-rdma-u79uwXL29TY76Z2rM5mHXA@public.gmane.org>,
	"dledford-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org"
	<dledford-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org>,
	"swise-7bPotxP6k4+P2YhJcF5u+vpXobYPEAuW@public.gmane.org"
	<swise-7bPotxP6k4+P2YhJcF5u+vpXobYPEAuW@public.gmane.org>,
	"markb-VPRAkNaXOzVWk0Htik3J/w@public.gmane.org"
	<markb-VPRAkNaXOzVWk0Htik3J/w@public.gmane.org>
Subject: Re: [PATCH rdma-next v4 1/7] RDMA/restrack: Add general infrastructure to track RDMA resources
Date: Thu, 18 Jan 2018 07:42:52 +0200	[thread overview]
Message-ID: <20180118054252.GU13639@mtr-leonro.local> (raw)
In-Reply-To: <1516253594.3665.10.camel-Sjgp3cTcYWE@public.gmane.org>

[-- Attachment #1: Type: text/plain, Size: 896 bytes --]

On Thu, Jan 18, 2018 at 05:33:15AM +0000, Bart Van Assche wrote:
> On Thu, 2018-01-18 at 07:20 +0200, Leon Romanovsky wrote:
> > Please read Documentation/doc-guide/kernel-doc.rst - "In-line member
> > documentation comments" section.
>
> A quote from that document:
>
> <quote>
> Structure, union, and enumeration documentation
> -----------------------------------------------
>
> The general format of a struct, union, and enum kernel-doc comment is::
>
>   /**
>    * struct struct_name - Brief description.
>    * @member_name: Description of member member_name.
>    *
>    * Description of the structure.
>    */
> </quote>
>
> Since the above syntax is shown first I think it's the preferred syntax.

I like to have documentation in-place near their actual usage/declaration,
so as long as one of the options won't be marked as mandatory, I'll leave
my implementation.

Thanks

>
> Bart.

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

  parent reply	other threads:[~2018-01-18  5:42 UTC|newest]

Thread overview: 20+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-01-15 15:12 [PATCH rdma-next v4 0/7] RDMA resource tracking Leon Romanovsky
     [not found] ` <20180115151255.30167-1-leon-DgEjT+Ai2ygdnm+yROfE0A@public.gmane.org>
2018-01-15 15:12   ` [PATCH rdma-next v4 1/7] RDMA/restrack: Add general infrastructure to track RDMA resources Leon Romanovsky
     [not found]     ` <20180115151255.30167-2-leon-DgEjT+Ai2ygdnm+yROfE0A@public.gmane.org>
2018-01-16 21:19       ` Leon Romanovsky
2018-01-16 21:33       ` Bart Van Assche
     [not found]         ` <1516138397.2844.34.camel-Sjgp3cTcYWE@public.gmane.org>
2018-01-17  5:47           ` Leon Romanovsky
     [not found]             ` <20180117054721.GE13639-U/DQcQFIOTAAJjI8aNfphQ@public.gmane.org>
2018-01-18  3:32               ` Bart Van Assche
     [not found]                 ` <1516246321.3665.7.camel-Sjgp3cTcYWE@public.gmane.org>
2018-01-18  5:20                   ` Leon Romanovsky
     [not found]                     ` <20180118052020.GS13639-U/DQcQFIOTAAJjI8aNfphQ@public.gmane.org>
2018-01-18  5:33                       ` Bart Van Assche
     [not found]                         ` <1516253594.3665.10.camel-Sjgp3cTcYWE@public.gmane.org>
2018-01-18  5:42                           ` Leon Romanovsky [this message]
2018-01-15 15:12   ` [PATCH rdma-next v4 2/7] RDMA/core: Add helper function to create named QPs Leon Romanovsky
     [not found]     ` <20180115151255.30167-3-leon-DgEjT+Ai2ygdnm+yROfE0A@public.gmane.org>
2018-01-16 21:35       ` Bart Van Assche
     [not found]         ` <1516138540.2844.36.camel-Sjgp3cTcYWE@public.gmane.org>
2018-01-17  5:59           ` Leon Romanovsky
     [not found]             ` <20180117055942.GF13639-U/DQcQFIOTAAJjI8aNfphQ@public.gmane.org>
2018-01-18  3:22               ` Bart Van Assche
2018-01-15 15:12   ` [PATCH rdma-next v4 3/7] RDMA: Annotate create QP callers Leon Romanovsky
     [not found]     ` <20180115151255.30167-4-leon-DgEjT+Ai2ygdnm+yROfE0A@public.gmane.org>
2018-01-16 23:03       ` Steve Wise
2018-01-18  5:22         ` Leon Romanovsky
2018-01-15 15:12   ` [PATCH rdma-next v4 4/7] RDMA/core: Add resource tracking for create and destroy CQs Leon Romanovsky
2018-01-15 15:12   ` [PATCH rdma-next v4 5/7] RDMA/core: Add resource tracking for create and destroy PDs Leon Romanovsky
2018-01-15 15:12   ` [PATCH rdma-next v4 6/7] RDMA/nldev: Provide global resource utilization Leon Romanovsky
2018-01-15 15:12   ` [PATCH rdma-next v4 7/7] RDMA/nldev: Provide detailed QP information Leon Romanovsky

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20180118054252.GU13639@mtr-leonro.local \
    --to=leon-dgejt+ai2ygdnm+yrofe0a@public.gmane.org \
    --cc=Bart.VanAssche-Sjgp3cTcYWE@public.gmane.org \
    --cc=dledford-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org \
    --cc=jgg-VPRAkNaXOzVWk0Htik3J/w@public.gmane.org \
    --cc=linux-rdma-u79uwXL29TY76Z2rM5mHXA@public.gmane.org \
    --cc=markb-VPRAkNaXOzVWk0Htik3J/w@public.gmane.org \
    --cc=swise-7bPotxP6k4+P2YhJcF5u+vpXobYPEAuW@public.gmane.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.