Skip to content

Commit

Permalink
docs: i2c: avoid using ReST :doc:foo markup
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
mchehab authored and Jonathan Corbet committed Jun 17, 2021
1 parent 4d361d6 commit 25edd3a
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 4 deletions.
2 changes: 1 addition & 1 deletion Documentation/i2c/instantiating-devices.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Declare the I2C devices via ACPI
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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
Expand Down
3 changes: 2 additions & 1 deletion Documentation/i2c/old-module-parameters.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
binding model, it became clear that these per-module parameters were no
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".

Below is a mapping from the old module parameters to the new interface.
Expand Down
4 changes: 2 additions & 2 deletions Documentation/i2c/smbus-protocol.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ a different protocol operation entirely.
Each transaction type corresponds to a functionality flag. Before calling a
transaction function, a device driver should always check (just once) for
the corresponding functionality flag to ensure that the underlying I2C
adapter supports the transaction in question. See :doc:`functionality` for
the details.
adapter supports the transaction in question. See
Documentation/i2c/functionality.rst for the details.


Key to symbols
Expand Down

0 comments on commit 25edd3a

Please sign in to comment.