]> git.baikalelectronics.ru Git - kernel.git/commit
docs: drivers: fix some warnings at base/platform.c when building docs
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Tue, 14 Apr 2020 16:48:45 +0000 (18:48 +0200)
committerJonathan Corbet <corbet@lwn.net>
Mon, 20 Apr 2020 21:45:23 +0000 (15:45 -0600)
commit0673a9b754e63ed528b0c52331ac7ebdda15e86a
treed57c8175006a888a9740ae2ec64f463bb12cbd12
parent3c7c2a76f022c2b4c47737da1387cb8c45e1ea66
docs: drivers: fix some warnings at base/platform.c when building docs

Currrently, two warnings are generated when building docs:

./drivers/base/platform.c:136: WARNING: Unexpected indentation.
./drivers/base/platform.c:214: WARNING: Unexpected indentation.

As examples are code blocks, they should use "::" markup. However,

Example::

Is currently interpreted as a new section.

While we could fix kernel-doc to accept such new syntax, it is
easier to just replace it with:

For Example::

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/564273815a76136fb5e453969b1012a786d99e28.1586881715.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
drivers/base/platform.c