On 7/11/2019 8:16 PM, Jarkko Sakkinen wrote:
On Thu, Jul 11, 2019 at 10:58:13AM -0700, Sean Christopherson wrote:
The way to do this right would be to write a documentation block before
kdoc's for the functions. It is described in the last section of
https://www.kernel.org/doc/Documentation/kernel-doc-nano-HOWTO.txt0
I.e. organize the file as
1. Documentation block describing the theory of operation.
2. Functions and their associated documentations.
The kernel doc parser straight up doesn't work on asm functions, hence the
shenanigans to coerce it into thinking it's parsing a normal C function.
Aah. I think I was too hazy with my comment. Looked it from patchwork and
the documentation is mostly just fine.
For this patch this cruft nees to be removed:
- * %SGX_IOC_ENCLAVE_INIT ioctl
+ * %SGX_IOC_ENCLAVE_INIT ioctl
These make squashing the patch properly nasty.
Also there is one unwanted rename. Did not find anything else obviously
wrong.
Reformatted the comments. Tested with kernel-doc. Now v4 could be
converted and displayed nicely as man pages.
/Jarkko
