Skip to content

Commit 25edd3a

Browse files
mchehabJonathan Corbet
authored andcommitted
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>
1 parent 4d361d6 commit 25edd3a

3 files changed

Lines changed: 5 additions & 4 deletions

File tree

Documentation/i2c/instantiating-devices.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Declare the I2C devices via ACPI
5959
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
6060

6161
ACPI can also describe I2C devices. There is special documentation for this
62-
which is currently located at :doc:`../firmware-guide/acpi/enumeration`.
62+
which is currently located at Documentation/firmware-guide/acpi/enumeration.rst.
6363

6464

6565
Declare the I2C devices in board files

Documentation/i2c/old-module-parameters.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,8 @@ address), ``force`` (to forcibly attach the driver to a given device) and
1717
With the conversion of the I2C subsystem to the standard device driver
1818
binding model, it became clear that these per-module parameters were no
1919
longer needed, and that a centralized implementation was possible. The new,
20-
sysfs-based interface is described in :doc:`instantiating-devices`, section
20+
sysfs-based interface is described in
21+
Documentation/i2c/instantiating-devices.rst, section
2122
"Method 4: Instantiate from user-space".
2223

2324
Below is a mapping from the old module parameters to the new interface.

Documentation/i2c/smbus-protocol.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ a different protocol operation entirely.
2727
Each transaction type corresponds to a functionality flag. Before calling a
2828
transaction function, a device driver should always check (just once) for
2929
the corresponding functionality flag to ensure that the underlying I2C
30-
adapter supports the transaction in question. See :doc:`functionality` for
31-
the details.
30+
adapter supports the transaction in question. See
31+
Documentation/i2c/functionality.rst for the details.
3232

3333

3434
Key to symbols

0 commit comments

Comments
 (0)