lkml.org 
[lkml]   [2020]   [Sep]   [30]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
From
SubjectRE: [PATCH v4 47/52] docs: mei.rst: fix a C expression markup
Date

> Sphinx 3.x doesn't allow expressions using :c:func markup:
>
> ./Documentation/driver-api/mei/mei.rst:41: WARNING: Unparseable
> C cross-reference: 'close(int fd)'
> Invalid C declaration: Expected end of definition. [error at 5]
> close(int fd)
> -----^
>
> So, convert it into a :c:expr.
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Acked-by: Tomas Winkler <tomas.winkler@intel.com>

> ---
> Documentation/driver-api/mei/mei.rst | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/driver-api/mei/mei.rst b/Documentation/driver-
> api/mei/mei.rst
> index cea0b69ec216..4f2ced4ccdc6 100644
> --- a/Documentation/driver-api/mei/mei.rst
> +++ b/Documentation/driver-api/mei/mei.rst
> @@ -38,7 +38,7 @@ Because some of the Intel ME features can change the
> system
> configuration, the driver by default allows only a privileged
> user to access it.
>
> -The session is terminated calling :c:func:`close(int fd)`.
> +The session is terminated calling :c:expr:`close(fd)`.
>
> A code snippet for an application communicating with Intel AMTHI client:
>
> --
> 2.26.2

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