Re: [PATCH 1/9] kernel/api: introduce kernel API specification framework

Sasha Levin [off-list ref] writes:

quoted

quoted

+The framework exports specifications via debugfs that can be used
+to generate documentation. Tools for automatic documentation generation
+from specifications are planned for future development.

Documentation always comes last :)

So this is one thing I wanted to run by the doc maintainers: the kapi tool
already has the capability to export these specs in .rst format. Would it be
interesting to have a manual for kenrel APIs in Documentation/? It can be
automatically generated and updated and would always match the kernel code at
that point.

I suspect we could certainly find a place for it.  Maybe as a subsection
of the user-space API manual, at least for the system-call portion of
it.

Thanks,

jon