Scripts for regenerating documentation#215
Conversation
Add DOC: statements to the header files to have each header file start its own section in the API documentation. Signed-off-by: Hannes Reinecke <hare@suse.de>
Some function descriptions weren't properly specified. Signed-off-by: Hannes Reinecke <hare@suse.de>
|
Any particular reason why the scripts are in internal? We have a |
|
No particular reason. Just wanting to share what I've been able to find out; getting there was painful enough, and others shouldn't be made to suffer the same way. |
|
When the user doesn't tell meson to build the documentation via -Dman=true it installs the pre compiled ones? Would this work? Or do we an option to install only the documentation on request? |
|
Yes, that was the plan. With normal build the pre-compiled manpages get installed, and with 'meson -Dman=true' the manpages get regenerated. |
|
Only that 'meson -Dman=true' doesn't do that, cf issue #218. |
Import the 'kernel-doc' script from the linux kernel sources and add scripts to regenerate libnvme.rst and man-pages. Signed-off-by: Hannes Reinecke <hare@suse.de> [dwagner: moved scripts from internal to doc] Signed-off-by: Daniel Wagner <dwagner@suse.de>
|
I've just moved the scripts to the doc dir. |
Import the 'kernel-doc' script from the linux kernel sources and add scripts to regenerate libnvme.rst and the manual pages.