summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMarc Zyngier <maz@kernel.org>2021-09-03 10:29:07 +0200
committerMarc Zyngier <maz@kernel.org>2021-09-03 10:54:15 +0200
commit0ddc5e55e6f1da1286fb2646f4248bf7da31a601 (patch)
tree22d1c4dede6dfeb406b30b4bd4e14ff04a3f10df
parentMerge branch irq/qcom-pdc-nowake-cleanup into irq/irqchip-next (diff)
downloadlinux-0ddc5e55e6f1da1286fb2646f4248bf7da31a601.tar.xz
linux-0ddc5e55e6f1da1286fb2646f4248bf7da31a601.zip
Documentation: Fix irq-domain.rst build warning
Correctly escape the * not to be used as emphasis. Also take this opportunity to clarify the fate of the rest of the legacy APIs. Reported-by: Stephen Rothwell <sfr@canb.auug.org.au> Signed-off-by: Marc Zyngier <maz@kernel.org> Link: https://lore.kernel.org/r/20210903085343.923036-1-maz@kernel.org
-rw-r--r--Documentation/core-api/irq/irq-domain.rst5
1 files changed, 3 insertions, 2 deletions
diff --git a/Documentation/core-api/irq/irq-domain.rst b/Documentation/core-api/irq/irq-domain.rst
index 6979b4af2c1f..9c0e8758037a 100644
--- a/Documentation/core-api/irq/irq-domain.rst
+++ b/Documentation/core-api/irq/irq-domain.rst
@@ -175,9 +175,10 @@ for IRQ numbers that are passed to struct device registrations. In that
case the Linux IRQ numbers cannot be dynamically assigned and the legacy
mapping should be used.
-As the name implies, the *_legacy() functions are deprecated and only
+As the name implies, the \*_legacy() functions are deprecated and only
exist to ease the support of ancient platforms. No new users should be
-added.
+added. Same goes for the \*_simple() functions when their use results
+in the legacy behaviour.
The legacy map assumes a contiguous range of IRQ numbers has already
been allocated for the controller and that the IRQ number can be