UbiquitousOS
/
OpenCloudOS-Kernel
mirror of https://gitee.com/OpenCloudOS/OpenCloudOS-Kernel.git
11
0
Fork 0
Code Issues Projects Releases Wiki Activity

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>
This commit is contained in:
Mauro Carvalho Chehab 2021-06-16 08:27:30 +02:00 committed by Jonathan Corbet
parent 85aa9afd7b
commit bbbaf2264d
3 changed files with 14 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
Documentation/driver-api/surface_aggregator/clients/index.rst
View File

@ -5,7 +5,8 @@ Client Driver Documentation
=========================== ===========================
This is the documentation for client drivers themselves. Refer to 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:: .. toctree::
:maxdepth: 1 :maxdepth: 1

15
Documentation/driver-api/surface_aggregator/internal.rst
View File

@ -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| implemented as platform devices, via |ssam_device| and |ssam_device_driver|
simplify management of client devices and client drivers. simplify management of client devices and client drivers.
Refer to :doc:`client` for documentation regarding the client device/driver Refer to Documentation/driver-api/surface_aggregator/client.rst for
API and interface options for other kernel drivers. It is recommended to documentation regarding the client device/driver API and interface options
familiarize oneself with that chapter and the :doc:`ssh` before continuing for other kernel drivers. It is recommended to familiarize oneself with
with the architectural overview below. that chapter and the Documentation/driver-api/surface_aggregator/ssh.rst
before continuing with the architectural overview below.
Packet Transport Layer Packet Transport Layer
@ -190,9 +191,9 @@ with success on the transmitter thread.
Transmission of sequenced packets is limited by the number of concurrently 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 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` from the EC in parallel. This limit is currently set to one (see
for the reasoning behind this). Control packets (i.e. ACK and NAK) can Documentation/driver-api/surface_aggregator/ssh.rst for the reasoning behind
always be transmitted. this). Control packets (i.e. ACK and NAK) can always be transmitted.
Receiver Thread Receiver Thread
--------------- ---------------

6
Documentation/driver-api/surface_aggregator/overview.rst
View File

@ -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 without response as commands. In general, events need to be enabled via one
of multiple dedicated requests before they are sent by the EC. of multiple dedicated requests before they are sent by the EC.
See :doc:`ssh` for a more technical protocol documentation and See Documentation/driver-api/surface_aggregator/ssh.rst for a
:doc:`internal` for an overview of the internal driver architecture. more technical protocol documentation and
Documentation/driver-api/surface_aggregator/internal.rst for an
overview of the internal driver architecture.