Documentation

[brabo]

More documentation is needed. Doxygen?

[danielinux]

I remember discussing this with you. Doxygen is an option indeed, but I would like to avoid describing all the internal kernel functions.

API function (such as the interface exported by module.c for instance) might be useful for drivers developers.

I am more in favor of good, detailed text documentation than automatically generated from (usually lazy) code comments.

The wiki is still the best source of documentation we have right now.

[danielinux]

@brabo I propose we discuss the actions to be taken and properly divide this issue into more detailed ones? Issues like this could never be "done" otherwise.

I think a first few classifications should be done to help prioritize and choose platforms/actions:

• kernel vs userland
• API definition vs deep code analysis vs plain usage manual
• custom functionalities (e.g. xipfs)
• architecture and design choices (including workshop presentation material)
• What are the components in need for better explanation (kernel, userspace,
• What is the level of details we need to explain the kernel internals (tasklets, locks, timers, modules, etc.)
• What is the goal to meet with the documentation (i.e. how detailed should it be? Explain design choices or not?

[danielinux]

Issue boils up to:

• expand the wiki with kernel internals
• automate wiki page updates with new syscalls