On Wed, 19 Jul 2017 16:05:01 +0300 Jani Nikula <jani.nik...@intel.com> wrote:
> 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? Certainly I like the idea of automatically generating module parameter docs. I will confess that I don't like committing a duplicated version of those docs into the repository, though; nobody will ever update them until somebody complains. I'm also concerned about removing documentation from kernel-parameters.rst, since that's where people tend to go looking for such information now. I wonder if we could hack up some sort of trick using "cc -E" and a special include file to extract the info from the source? Then maybe a simple module-doc extension to run that trick and include the results? It means adding a little stanza for each module we want to document, but I'm not convinced that's worse than committing the documentation separately. Thoughts? Thanks, jon -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
