Re: [PATCH 19/34] docs: driver-api: surface_aggregator: avoid using ReSt :doc:`foo` markup

Maximilian Luz
2021-06-05T14:15:03Z

On 6/5/21 3:18 PM, Mauro Carvalho Chehab wrote:
> The :doc:`foo` tag is auto-generated via automarkup.py.
> So, use the filename at the sources, instead of :doc:`foo`.
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>

Acked-by: Maximilian Luz <luzmaximilian@gmail.com>

> ---
> .../surface_aggregator/clients/index.rst | 3 ++-
> .../driver-api/surface_aggregator/internal.rst | 15 ++++++++-------
> .../driver-api/surface_aggregator/overview.rst | 6 ++++--
> 3 files changed, 14 insertions(+), 10 deletions(-)
>
> diff --git a/Documentation/driver-api/surface_aggregator/clients/index.rst b/Documentation/driver-api/surface_aggregator/clients/index.rst
> index 98ea9946b8a2..30160513afa5 100644
> --- a/Documentation/driver-api/surface_aggregator/clients/index.rst
> +++ b/Documentation/driver-api/surface_aggregator/clients/index.rst
> @@ -5,7 +5,8 @@ Client Driver Documentation
> ===========================
>
> This is the documentation for client drivers themselves. Refer to
> -:doc:`../client` for documentation on how to write client drivers.
> +Documentation/driver-api/surface_aggregator/client.rst for documentation
> +on how to write client drivers.
>
> .. toctree::
> :maxdepth: 1
> diff --git a/Documentation/driver-api/surface_aggregator/internal.rst b/Documentation/driver-api/surface_aggregator/internal.rst
> index 72704734982a..8c7c80c9f418 100644
> --- a/Documentation/driver-api/surface_aggregator/internal.rst
> +++ b/Documentation/driver-api/surface_aggregator/internal.rst
> @@ -87,10 +87,11 @@ native SSAM devices, i.e. devices that are not defined in ACPI and not
> implemented as platform devices, via |ssam_device| and |ssam_device_driver|
> simplify management of client devices and client drivers.
>
> -Refer to :doc:`client` for documentation regarding the client device/driver
> -API and interface options for other kernel drivers. It is recommended to
> -familiarize oneself with that chapter and the :doc:`ssh` before continuing
> -with the architectural overview below.
> +Refer to Documentation/driver-api/surface_aggregator/client.rst for
> +documentation regarding the client device/driver API and interface options
> +for other kernel drivers. It is recommended to familiarize oneself with
> +that chapter and the Documentation/driver-api/surface_aggregator/ssh.rst
> +before continuing with the architectural overview below.
>
>
> Packet Transport Layer
> @@ -190,9 +191,9 @@ with success on the transmitter thread.
>
> Transmission of sequenced packets is limited by the number of concurrently
> pending packets, i.e. a limit on how many packets may be waiting for an ACK
> -from the EC in parallel. This limit is currently set to one (see :doc:`ssh`
> -for the reasoning behind this). Control packets (i.e. ACK and NAK) can
> -always be transmitted.
> +from the EC in parallel. This limit is currently set to one (see
> +Documentation/driver-api/surface_aggregator/ssh.rst for the reasoning behind
> +this). Control packets (i.e. ACK and NAK) can always be transmitted.
>
> Receiver Thread
> ---------------
> diff --git a/Documentation/driver-api/surface_aggregator/overview.rst b/Documentation/driver-api/surface_aggregator/overview.rst
> index 1e9d57e50063..26415e1ab7da 100644
> --- a/Documentation/driver-api/surface_aggregator/overview.rst
> +++ b/Documentation/driver-api/surface_aggregator/overview.rst
> @@ -73,5 +73,7 @@ being a direct response to a previous request. We may also refer to requests
> without response as commands. In general, events need to be enabled via one
> of multiple dedicated requests before they are sent by the EC.
>
> -See :doc:`ssh` for a more technical protocol documentation and
> -:doc:`internal` for an overview of the internal driver architecture.
> +See Documentation/driver-api/surface_aggregator/ssh.rst for a
> +more technical protocol documentation and
> +Documentation/driver-api/surface_aggregator/internal.rst for an
> +overview of the internal driver architecture.
>