Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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>

authored by

Mauro Carvalho Chehab and committed by
Jonathan Corbet
bbbaf226 85aa9afd

+14 -10
+2 -1
Documentation/driver-api/surface_aggregator/clients/index.rst
··· 5 5 =========================== 6 6 7 7 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. 9 10 10 11 .. toctree:: 11 12 :maxdepth: 1
+8 -7
Documentation/driver-api/surface_aggregator/internal.rst
··· 87 87 implemented as platform devices, via |ssam_device| and |ssam_device_driver| 88 88 simplify management of client devices and client drivers. 89 89 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. 94 95 95 96 96 97 Packet Transport Layer ··· 191 190 192 191 Transmission of sequenced packets is limited by the number of concurrently 193 192 pending packets, i.e. a limit on how many packets may be waiting for an ACK 194 - from the EC in parallel. This limit is currently set to one (see :doc:`ssh` 195 - for the reasoning behind this). Control packets (i.e. ACK and NAK) can 196 - always be transmitted. 193 + from the EC in parallel. This limit is currently set to one (see 194 + Documentation/driver-api/surface_aggregator/ssh.rst for the reasoning behind 195 + this). Control packets (i.e. ACK and NAK) can always be transmitted. 197 196 198 197 Receiver Thread 199 198 ---------------
+4 -2
Documentation/driver-api/surface_aggregator/overview.rst
··· 73 73 without response as commands. In general, events need to be enabled via one 74 74 of multiple dedicated requests before they are sent by the EC. 75 75 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.