lkml.org 
[lkml]   [2020]   [Apr]   [14]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    Patch in this message
    /
    From
    Subject[PATCH v2 19/33] docs: drivers: fix some warnings at base/platform.c when building docs
    Date
    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>
    ---
    drivers/base/platform.c | 6 ++++--
    1 file 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;
    --
    2.25.2
    \
     
     \ /
      Last update: 2020-04-14 18:56    [W:3.236 / U:0.068 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site