openkylin
/
linux
mirror of https://gitee.com/openkylin/linux.git
9
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: i2c: 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: Wolfram Sang <wsa@kernel.org>
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/569722e3f7d73d746c145ea78d2b4fbe5defee90.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:33 +02:00 committed by Jonathan Corbet
parent 4d361d6cc7
commit 25edd3a162
3 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Documentation/i2c/instantiating-devices.rst
View File

@ -59,7 +59,7 @@ Declare the I2C devices via ACPI
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
ACPI can also describe I2C devices. There is special documentation for this ACPI can also describe I2C devices. There is special documentation for this
which is currently located at :doc:`../firmware-guide/acpi/enumeration`. which is currently located at Documentation/firmware-guide/acpi/enumeration.rst.
Declare the I2C devices in board files Declare the I2C devices in board files

3
Documentation/i2c/old-module-parameters.rst
View File

@ -17,7 +17,8 @@ address), ``force`` (to forcibly attach the driver to a given device) and
With the conversion of the I2C subsystem to the standard device driver With the conversion of the I2C subsystem to the standard device driver
binding model, it became clear that these per-module parameters were no binding model, it became clear that these per-module parameters were no
longer needed, and that a centralized implementation was possible. The new, longer needed, and that a centralized implementation was possible. The new,
sysfs-based interface is described in :doc:`instantiating-devices`, section sysfs-based interface is described in
Documentation/i2c/instantiating-devices.rst, section
"Method 4: Instantiate from user-space". "Method 4: Instantiate from user-space".
Below is a mapping from the old module parameters to the new interface. Below is a mapping from the old module parameters to the new interface.

4
Documentation/i2c/smbus-protocol.rst
View File

@ -27,8 +27,8 @@ a different protocol operation entirely.
Each transaction type corresponds to a functionality flag. Before calling a Each transaction type corresponds to a functionality flag. Before calling a
transaction function, a device driver should always check (just once) for transaction function, a device driver should always check (just once) for
the corresponding functionality flag to ensure that the underlying I2C the corresponding functionality flag to ensure that the underlying I2C
adapter supports the transaction in question. See :doc:`functionality` for adapter supports the transaction in question. See
the details. Documentation/i2c/functionality.rst for the details.
Key to symbols Key to symbols