linux-kernel - [irqchip: irq/irqchip-fixes] Documentation: Fix irq-domain.rst build warning

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Date:   Fri, 03 Sep 2021 08:56:25 -0000
From:   "irqchip-bot for Marc Zyngier" <tip-bot2@...utronix.de>
To:     linux-kernel@...r.kernel.org
Cc:     Stephen Rothwell <sfr@...b.auug.org.au>,
        Marc Zyngier <maz@...nel.org>, tglx@...utronix.de
Subject: [irqchip: irq/irqchip-fixes] Documentation: Fix irq-domain.rst build warning

The following commit has been merged into the irq/irqchip-fixes branch of irqchip:

Commit-ID:     0ddc5e55e6f1da1286fb2646f4248bf7da31a601
Gitweb:        https://git.kernel.org/pub/scm/linux/kernel/git/maz/arm-platforms/0ddc5e55e6f1da1286fb2646f4248bf7da31a601
Author:        Marc Zyngier <maz@...nel.org>
AuthorDate:    Fri, 03 Sep 2021 09:29:07 +01:00
Committer:     Marc Zyngier <maz@...nel.org>
CommitterDate: Fri, 03 Sep 2021 09:54:15 +01:00

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@...b.auug.org.au>
Signed-off-by: Marc Zyngier <maz@...nel.org>
Link: https://lore.kernel.org/r/20210903085343.923036-1-maz@kernel.org
---
 Documentation/core-api/irq/irq-domain.rst | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/Documentation/core-api/irq/irq-domain.rst b/Documentation/core-api/irq/irq-domain.rst
index 6979b4a..9c0e875 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