Skip to content

Commit bbbaf22

Browse files
mchehabJonathan Corbet
authored andcommitted
docs: driver-api: surface_aggregator: avoid using ReST :doc:foo markup
The :doc:`foo` tag is auto-generated via automarkup.py. So, use the filename at the sources, instead of :doc:`foo`. Acked-by: Maximilian Luz <luzmaximilian@gmail.com> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Link: https://lore.kernel.org/r/6097027b4de4c9015485cb73b297b98660c4296d.1623824363.git.mchehab+huawei@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
1 parent 85aa9af commit bbbaf22

3 files changed

Lines changed: 14 additions & 10 deletions

File tree

Documentation/driver-api/surface_aggregator/clients/index.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@ Client Driver Documentation
55
===========================
66

77
This is the documentation for client drivers themselves. Refer to
8-
:doc:`../client` for documentation on how to write client drivers.
8+
Documentation/driver-api/surface_aggregator/client.rst for documentation
9+
on how to write client drivers.
910

1011
.. toctree::
1112
:maxdepth: 1

Documentation/driver-api/surface_aggregator/internal.rst

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -87,10 +87,11 @@ native SSAM devices, i.e. devices that are not defined in ACPI and not
8787
implemented as platform devices, via |ssam_device| and |ssam_device_driver|
8888
simplify management of client devices and client drivers.
8989

90-
Refer to :doc:`client` for documentation regarding the client device/driver
91-
API and interface options for other kernel drivers. It is recommended to
92-
familiarize oneself with that chapter and the :doc:`ssh` before continuing
93-
with the architectural overview below.
90+
Refer to Documentation/driver-api/surface_aggregator/client.rst for
91+
documentation regarding the client device/driver API and interface options
92+
for other kernel drivers. It is recommended to familiarize oneself with
93+
that chapter and the Documentation/driver-api/surface_aggregator/ssh.rst
94+
before continuing with the architectural overview below.
9495

9596

9697
Packet Transport Layer
@@ -190,9 +191,9 @@ with success on the transmitter thread.
190191

191192
Transmission of sequenced packets is limited by the number of concurrently
192193
pending packets, i.e. a limit on how many packets may be waiting for an ACK
193-
from the EC in parallel. This limit is currently set to one (see :doc:`ssh`
194-
for the reasoning behind this). Control packets (i.e. ACK and NAK) can
195-
always be transmitted.
194+
from the EC in parallel. This limit is currently set to one (see
195+
Documentation/driver-api/surface_aggregator/ssh.rst for the reasoning behind
196+
this). Control packets (i.e. ACK and NAK) can always be transmitted.
196197

197198
Receiver Thread
198199
---------------

Documentation/driver-api/surface_aggregator/overview.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,5 +73,7 @@ being a direct response to a previous request. We may also refer to requests
7373
without response as commands. In general, events need to be enabled via one
7474
of multiple dedicated requests before they are sent by the EC.
7575

76-
See :doc:`ssh` for a more technical protocol documentation and
77-
:doc:`internal` for an overview of the internal driver architecture.
76+
See Documentation/driver-api/surface_aggregator/ssh.rst for a
77+
more technical protocol documentation and
78+
Documentation/driver-api/surface_aggregator/internal.rst for an
79+
overview of the internal driver architecture.

0 commit comments

Comments
 (0)