Hi Jon, all, here are some quick'n'dirty patches to semi-automatically
generate module param documentation from the source, via module build
and modinfo(8). No polish or proper design, just a hacked up
proof-of-concept to think about.
Do we want nice documentation for module parameters, somewhere that
search engines can find them? And do we want to reuse the documentation
already in place for parameters?
BR,
Jani.
Jani Nikula (4):
scripts: add modinfo-to-rst script to extract module parameters
Documentation: start module parameter documentation autogenerated from
modinfo
Documentation: add drm and drm_kms_helper module param documentation
scripts: add modparams-docs-update script to update all module
parameter docs
Documentation/admin-guide/kernel-parameters.rst | 8 ++
Documentation/admin-guide/kernel-parameters.txt | 32 ------
Documentation/admin-guide/module-parameters/README | 14 +++
.../admin-guide/module-parameters/drm.rst | 26 +++++
.../module-parameters/drm_kms_helper.rst | 23 ++++
.../admin-guide/module-parameters/i915.rst | 125 +++++++++++++++++++++
scripts/modinfo-to-rst | 24 ++++
scripts/modparams-docs-update | 20 ++++
8 files changed, 240 insertions(+), 32 deletions(-)
create mode 100644 Documentation/admin-guide/module-parameters/README
create mode 100644 Documentation/admin-guide/module-parameters/drm.rst
create mode 100644
Documentation/admin-guide/module-parameters/drm_kms_helper.rst
create mode 100644 Documentation/admin-guide/module-parameters/i915.rst
create mode 100755 scripts/modinfo-to-rst
create mode 100755 scripts/modparams-docs-update
--
2.11.0
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to [email protected]
More majordomo info at http://vger.kernel.org/majordomo-info.html
