Re: [Ksummit-discuss] [MAINTAINERS SUMMIT] Documentation issues

[Matthew Wilcox <willy6545@gmail.com>]

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

I find documentation comes in the following bins:

1. User documentation (possible sub-split into "how to use this from kernel
space" and "how to use this from user space")
2. Information for someone who's interested in modifying the code. Possibly
including architectural considerations (eg locking), performance, ideas for
future improvement, etc.
3. Random swearing and abuse

I think the second and third categories of documentation should be kept out
of the kernel books and left as plain comments by the code.

On 24 Jun 2017 9:41 am, "Mauro Carvalho Chehab" <mchehab@s-opensource.com>
wrote:

Yeah, one of the problems with existing documentation is that,
sometimes, the same document describes both userspace-relevant
info and kernelspace APIs.

[-- Attachment #2: Type: text/html, Size: 1354 bytes --]