linux-kernel - RE: [PATCH v4 47/52] docs: mei.rst: fix a C expression markup

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <3d1fd098e3bf43af9144bd6c068ee9aa@intel.com>
Date:   Wed, 30 Sep 2020 20:30:12 +0000
From:   "Winkler, Tomas" <tomas.winkler@...el.com>
To:     Mauro Carvalho Chehab <mchehab+huawei@...nel.org>,
        Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        Jonathan Corbet <corbet@....net>
CC:     "linux-kernel@...r.kernel.org" <linux-kernel@...r.kernel.org>
Subject: RE: [PATCH v4 47/52] docs: mei.rst: fix a C expression markup


> 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@...nel.org>
Acked-by: Tomas Winkler <tomas.winkler@...el.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