On Thu, Jul 07, 2022 at 12:32:14AM -0700, Hellstrom, Thomas wrote:
On Wed, 2022-07-06 at 22:01 -0700, Niranjana Vishwanathapura wrote:
> > + /**
> > + * true: allow only vm_bind method of binding.
> > + * false: allow only legacy execbuff method of binding.
> > + */
>
> Use proper kerneldoc. (Same holds for structure documentation
> across
> the series).
> Also please follow internal locking guidelines on documentation of
> members that need protection with locks.
I just followed the documentation convention that was already there
;)
I think we need a prep patch in this series that adds kernel-doc for
these structures and then add new fields for vm_bind with proper
kernel-docs.
That would be awesome if we could do that, but as a minimum, I think
that new in-line struct / union comments should follow
https://www.kernel.org/doc/html/v5.3/doc-guide/kernel-doc.html#in-line-member-documentation-comments
and completely new struct / unions should follow
https://www.kernel.org/doc/html/v5.3/doc-guide/kernel-doc.html#in-line-member-documentation-comments,
and in particular the internal locking guidelines what members are
protected with what locks and, if applicable, how. (For example a
member may be protected by two locks when writing to it and only one of
the locks when reading).
Sounds good.
Niranjana
/Thomas
