linux-kernel - Re: [RFC v2 32/38] docs: iio: Allow creating cross-references ABI

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: <20250128182739.704c7823@jic23-huawei>
Date: Tue, 28 Jan 2025 18:27:39 +0000
From: Jonathan Cameron <jic23@...nel.org>
To: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
Cc: Linux Doc Mailing List <linux-doc@...r.kernel.org>, Jonathan Corbet
 <corbet@....net>, Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
 Lars-Peter Clausen <lars@...afoo.de>, Thorsten Scherer
 <t.scherer@...elmann.de>, linux-iio@...r.kernel.org,
 linux-kernel@...r.kernel.org
Subject: Re: [RFC v2 32/38] docs: iio: Allow creating cross-references ABI

On Tue, 28 Jan 2025 01:06:21 +0100
Mauro Carvalho Chehab <mchehab+huawei@...nel.org> wrote:

> Now that Documentation/ABI is processed by automarkup, let it
> generate cross-references for the corresponding ABI file.
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
Acked-by: Jonathan Cameron <Jonathan.Cameron@...wei.com>

> ---
>  Documentation/driver-api/iio/core.rst | 2 +-
>  Documentation/iio/iio_devbuf.rst      | 2 +-
>  2 files changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/driver-api/iio/core.rst b/Documentation/driver-api/iio/core.rst
> index dfe438dc91a7..42b580fb2989 100644
> --- a/Documentation/driver-api/iio/core.rst
> +++ b/Documentation/driver-api/iio/core.rst
> @@ -60,7 +60,7 @@ directory.  Common attributes are:
>  * :file:`sampling_frequency_available`, available discrete set of sampling
>    frequency values for device.
>  * Available standard attributes for IIO devices are described in the
> -  :file:`Documentation/ABI/testing/sysfs-bus-iio` file in the Linux kernel
> +  :file:Documentation/ABI/testing/sysfs-bus-iio file in the Linux kernel
>    sources.
>  
>  IIO device channels
> diff --git a/Documentation/iio/iio_devbuf.rst b/Documentation/iio/iio_devbuf.rst
> index 9919e4792d0e..dca1f0200b0d 100644
> --- a/Documentation/iio/iio_devbuf.rst
> +++ b/Documentation/iio/iio_devbuf.rst
> @@ -148,5 +148,5 @@ applied), however there are corner cases in which the buffered data may be found
>  in a processed form. Please note that these corner cases are not addressed by
>  this documentation.
>  
> -Please see ``Documentation/ABI/testing/sysfs-bus-iio`` for a complete
> +Please see Documentation/ABI/testing/sysfs-bus-iio for a complete
>  description of the attributes.