lkml.org 
[lkml]   [2020]   [Sep]   [30]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
From
Date
SubjectRe: [PATCH v4 31/52] docs: device_link.rst: remove duplicated kernel-doc include
On Wed, Sep 30, 2020 at 6:25 AM Mauro Carvalho Chehab
<mchehab+huawei@kernel.org> wrote:
>
> The infrastructure.rst file already includes the external
> symbols from drivers/base/core.c.
>
> Duplicating 3 functions there causes namespace collisions:
>
> Documentation/driver-api/device_link.rst: WARNING: Duplicate C declaration, also defined in 'driver-api/infrastructure'.
> Declaration is 'device_link_state'.
> Documentation/driver-api/device_link.rst: WARNING: Duplicate C declaration, also defined in 'driver-api/infrastructure'.
> Declaration is 'device_link_add'.
> Documentation/driver-api/device_link.rst: WARNING: Duplicate C declaration, also defined in 'driver-api/infrastructure'.
> Declaration is 'device_link_del'.
> Documentation/driver-api/device_link.rst: WARNING: Duplicate C declaration, also defined in 'driver-api/infrastructure'.
> Declaration is 'device_link_remove'.
>
> So, drop the reference, adding just a mention to the functions
> associated with device_link.
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> ---
> Documentation/driver-api/device_link.rst | 3 +--
> 1 file changed, 1 insertion(+), 2 deletions(-)
>
> diff --git a/Documentation/driver-api/device_link.rst b/Documentation/driver-api/device_link.rst
> index 76950d061632..ee913ae16371 100644
> --- a/Documentation/driver-api/device_link.rst
> +++ b/Documentation/driver-api/device_link.rst
> @@ -317,5 +317,4 @@ State machine
> API
> ===
>
> -.. kernel-doc:: drivers/base/core.c
> - :functions: device_link_add device_link_del device_link_remove
> +See device_link_add(), device_link_del() and device_link_remove().

I just "copy paste" rst formatting because I've never bothered to
understand it. If these changes fix warnings, I'm okay with them. They
seem pretty harmless.

-Saravana

\
 
 \ /
  Last update: 2020-09-30 23:04    [W:0.331 / U:3.044 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site