On Mon, 27 Mar 2017, Julia Lawall <julia.lawall@xxxxxxx> wrote:
> Kerneldoc seems to be written sometimes kerneldoc and sometimes
> kernel-doc. Which is preferred? Having two spellings makes it hard to
> use grep to find out what are the conventions for writing kernel
> documentation.
I think "kernel-doc" is the original name for the source code comment
format and the tool that parses it (scripts/kernel-doc). It's also the
name of the Sphinx directive for including the comments into
reStructuredText.
Part of the confusion undoubtedly comes from commit 58af04dff742
("Documentation/sphinx: rename kernel-doc.py to kerneldoc.py") to
appease Python and its module naming conventions.
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 majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
