On Fri, 28 Oct 2016, Mauro Carvalho Chehab <mche...@s-opensource.com> wrote: > This patch series fix a few issues on some ABI files that violate what's > written at Documentation/ABI/README, and add a parser, using > kernel-cmd, to produce an ABI book. A parsed version of it can be found at: > > https://mchehab.fedorapeople.org/kernel_docs/admin-guide/abi.html
So here's a constructive counter proposal: How about using the perl script you wrote to convert the ABI documentation into reStructuredText format, committing the changes, and maintaining ABI documentation in reStructuredText going forward? This would keep the Sphinx build simple and allow richer ABI documentation than the preformatted text blocks in above URL. I think this would be a worthy improvement in the documentation. The format of the ABI documentation is not ABI... we have no obligation to keep it in some old ad hoc text format. Perhaps there's value in having a "database" format. But using rst does not preclude us from formatting the documentation in a way that's also parseable using a script. For example, use uniform header styles, use definition lists with fixed terms, etc. BR, Jani. -- Jani Nikula, Intel Open Source Technology Center -- 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
