diff options
| author | Mauro Carvalho Chehab <mchehab+huawei@kernel.org> | 2020-04-14 18:48:45 +0200 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2020-04-20 23:45:23 +0200 |
| commit | f08252469ef5b10863424e502bb1ed049d18390c (patch) | |
| tree | d57c8175006a888a9740ae2ec64f463bb12cbd12 /drivers/base/platform.c | |
| parent | docs: spi: spi.h: fix a doc building warning (diff) | |
| download | linux-f08252469ef5b10863424e502bb1ed049d18390c.tar.xz linux-f08252469ef5b10863424e502bb1ed049d18390c.zip | |
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>
Diffstat (limited to 'drivers/base/platform.c')
| -rw-r--r-- | drivers/base/platform.c | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/drivers/base/platform.c b/drivers/base/platform.c index 5255550b7c34..a07e28eab7d7 100644 --- a/drivers/base/platform.c +++ b/drivers/base/platform.c @@ -147,7 +147,8 @@ EXPORT_SYMBOL_GPL(devm_platform_ioremap_resource_byname); * request_irq() APIs. This is the same as platform_get_irq(), except that it * does not print an error message if an IRQ can not be obtained. * - * Example: + * For example:: + * * int irq = platform_get_irq_optional(pdev, 0); * if (irq < 0) * return irq; @@ -226,7 +227,8 @@ EXPORT_SYMBOL_GPL(platform_get_irq_optional); * IRQ fails. Device drivers should check the return value for errors so as to * not pass a negative integer value to the request_irq() APIs. * - * Example: + * For example:: + * * int irq = platform_get_irq(pdev, 0); * if (irq < 0) * return irq; |