This is an old revision of the document!
README file for each module is generated from xml docbook files residing in doc/ sub folder. When one adds a new module it has to write these files, then generate the README using:
make modules-readme modules=modules/modname
The docbook file are:
The docbook file are:
To generate IDs that make html version of README easier to refer to, each section tag for parameters, functions, etc. has to contain an id attribute. To avoid conflicts when merging some readme file, the value of ID attributes should use following pattern:
[module name] [dot] [type] [dot] [title]
The [type] should be:
Next is an example showing the id for the section corresponding to parameter workers from module async:
<section id="async.p.workers"> <title><varname>workers</varname> (int)</title>