lkml.org 
[lkml]   [2020]   [Apr]   [8]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    Patch in this message
    /
    From
    Subject[PATCH 13/35] ata: libata-core: fix a doc warning
    Date
    The docs toolchain doesn't recognise this pattern:

    @link->[hw_]sata_spd_limit

    As it can't really process it. So, instead, let's mark it with
    a literal block markup:

    ``link->[hw_]sata_spd_limit``

    in order to get rid of the following warning:

    ./drivers/ata/libata-core.c:5974: WARNING: Unknown target name: "hw".

    Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
    ---
    drivers/ata/libata-core.c | 2 +-
    1 file changed, 1 insertion(+), 1 deletion(-)

    diff --git a/drivers/ata/libata-core.c b/drivers/ata/libata-core.c
    index beca5f91bb4c..69361ec43db5 100644
    --- a/drivers/ata/libata-core.c
    +++ b/drivers/ata/libata-core.c
    @@ -5209,7 +5209,7 @@ void ata_link_init(struct ata_port *ap, struct ata_link *link, int pmp)
    * sata_link_init_spd - Initialize link->sata_spd_limit
    * @link: Link to configure sata_spd_limit for
    *
    - * Initialize @link->[hw_]sata_spd_limit to the currently
    + * Initialize ``link->[hw_]sata_spd_limit`` to the currently
    * configured value.
    *
    * LOCKING:
    --
    2.25.2
    \
     
     \ /
      Last update: 2020-04-08 17:49    [W:4.103 / U:0.016 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site