Skip to content

Commit a873add

Browse files
committed
Merge branch 'acpi-docs'
Merge an ACPI documentation update for 6.9-rc1 which adds markup to generate links from footnotes in the enumeration document. * acpi-docs: ACPI: docs: enumeration: Make footnotes links
2 parents d7ef570 + e1c69f3 commit a873add

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

Documentation/firmware-guide/acpi/enumeration.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -595,7 +595,7 @@ bridges/switches of the board.
595595

596596
For example, let's assume we have a system with a PCIe serial port, an
597597
Exar XR17V3521, soldered on the main board. This UART chip also includes
598-
16 GPIOs and we want to add the property ``gpio-line-names`` [1] to these pins.
598+
16 GPIOs and we want to add the property ``gpio-line-names`` [1]_ to these pins.
599599
In this case, the ``lspci`` output for this component is::
600600

601601
07:00.0 Serial controller: Exar Corp. XR17V3521 Dual PCIe UART (rev 03)
@@ -637,7 +637,7 @@ of the chipset bridge (also called "root port") with address::
637637
Bus: 0 - Device: 14 - Function: 1
638638

639639
To find this information, it is necessary to disassemble the BIOS ACPI tables,
640-
in particular the DSDT (see also [2])::
640+
in particular the DSDT (see also [2]_)::
641641

642642
mkdir ~/tables/
643643
cd ~/tables/
@@ -667,7 +667,7 @@ device::
667667
}
668668
... other definitions follow ...
669669

670-
and the _ADR method [3] returns exactly the device/function couple that
670+
and the _ADR method [3]_ returns exactly the device/function couple that
671671
we are looking for. With this information and analyzing the above ``lspci``
672672
output (both the devices list and the devices tree), we can write the following
673673
ACPI description for the Exar PCIe UART, also adding the list of its GPIO line
@@ -724,10 +724,10 @@ created analyzing the position of the Exar UART in the PCI bus topology.
724724
References
725725
==========
726726

727-
[1] Documentation/firmware-guide/acpi/gpio-properties.rst
727+
.. [1] Documentation/firmware-guide/acpi/gpio-properties.rst
728728
729-
[2] Documentation/admin-guide/acpi/initrd_table_override.rst
729+
.. [2] Documentation/admin-guide/acpi/initrd_table_override.rst
730730
731-
[3] ACPI Specifications, Version 6.3 - Paragraph 6.1.1 _ADR Address)
731+
.. [3] ACPI Specifications, Version 6.3 - Paragraph 6.1.1 _ADR Address)
732732
https://uefi.org/sites/default/files/resources/ACPI_6_3_May16.pdf,
733733
referenced 2020-11-18

0 commit comments

Comments
 (0)