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

Mauro Carvalho Chehab posted 38 patches 10 months, 3 weeks ago
[RFC v2 32/38] docs: iio: Allow creating cross-references ABI
Posted by Mauro Carvalho Chehab 10 months, 3 weeks ago
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@kernel.org>
---
 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.
-- 
2.48.1
Re: [RFC v2 32/38] docs: iio: Allow creating cross-references ABI
Posted by Jonathan Cameron 10 months, 3 weeks ago
On Tue, 28 Jan 2025 01:06:21 +0100
Mauro Carvalho Chehab <mchehab+huawei@kernel.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@kernel.org>
Acked-by: Jonathan Cameron <Jonathan.Cameron@huawei.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.