scripts: kernel-doc: allow passing desired Sphinx C domain dialect
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Sun, 4 Oct 2020 07:44:28 +0000 (09:44 +0200)
committerMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Thu, 15 Oct 2020 05:49:36 +0000 (07:49 +0200)
commit93351d4196802b3ee01074d96df47b73716984ba
treead992a9d39fd6513dd719a418d6792906ecff47e
parented8348e23abce79780f3b679c74a48bcdc47c947
scripts: kernel-doc: allow passing desired Sphinx C domain dialect

When kernel-doc is called via kerneldoc.py, there's no need to
auto-detect the Sphinx version, as the Sphinx module already
knows it. So, add an optional parameter to allow changing the
Sphinx dialect.

As kernel-doc can also be manually called, keep the auto-detection
logic if the parameter was not specified. On such case, emit
a warning if sphinx-build can't be found at PATH.

I ended using a suggestion from Joe for using a more readable
regex, instead of using a complex one with a hidden group like:

m/^(\d+)\.(\d+)(?:\.?(\d+)?)/

in order to get the optional <patch> argument.

Thanks-to: Joe Perches <joe@perches.com>
Suggested-by: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Documentation/sphinx/kerneldoc.py
scripts/kernel-doc