public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
* [PATCH] genericirq.rst: Remove :c:func:`...` in code blocks
@ 2017-11-28  5:16 Jonathan Neuschäfer
  2017-12-02 15:42 ` Jonathan Corbet
  0 siblings, 1 reply; 2+ messages in thread
From: Jonathan Neuschäfer @ 2017-11-28  5:16 UTC (permalink / raw)
  To: linux-doc
  Cc: Jonathan Neuschäfer, Jonathan Corbet, Mauro Carvalho Chehab,
	linux-kernel

In code blocks, :c:func:`...` annotations don't result in
cross-references. Instead, they are rendered verbatim.  Remove these
broken annotations, and mark function calls with parentheses() again.

Fixes: 76d40fae1351 ("genericirq.rst: add cross-reference links and use monospaced fonts")
Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
---
 Documentation/core-api/genericirq.rst | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/Documentation/core-api/genericirq.rst b/Documentation/core-api/genericirq.rst
index 0054bd48be84..4da67b65cecf 100644
--- a/Documentation/core-api/genericirq.rst
+++ b/Documentation/core-api/genericirq.rst
@@ -225,9 +225,9 @@ interrupts.
 
 The following control flow is implemented (simplified excerpt)::
 
-    :c:func:`desc->irq_data.chip->irq_mask_ack`;
+    desc->irq_data.chip->irq_mask_ack();
     handle_irq_event(desc->action);
-    :c:func:`desc->irq_data.chip->irq_unmask`;
+    desc->irq_data.chip->irq_unmask();
 
 
 Default Fast EOI IRQ flow handler
@@ -239,7 +239,7 @@ which only need an EOI at the end of the handler.
 The following control flow is implemented (simplified excerpt)::
 
     handle_irq_event(desc->action);
-    :c:func:`desc->irq_data.chip->irq_eoi`;
+    desc->irq_data.chip->irq_eoi();
 
 
 Default Edge IRQ flow handler
@@ -251,15 +251,15 @@ interrupts.
 The following control flow is implemented (simplified excerpt)::
 
     if (desc->status & running) {
-        :c:func:`desc->irq_data.chip->irq_mask_ack`;
+        desc->irq_data.chip->irq_mask_ack();
         desc->status |= pending | masked;
         return;
     }
-    :c:func:`desc->irq_data.chip->irq_ack`;
+    desc->irq_data.chip->irq_ack();
     desc->status |= running;
     do {
         if (desc->status & masked)
-            :c:func:`desc->irq_data.chip->irq_unmask`;
+            desc->irq_data.chip->irq_unmask();
         desc->status &= ~pending;
         handle_irq_event(desc->action);
     } while (status & pending);
@@ -293,10 +293,10 @@ simplified version without locking.
 The following control flow is implemented (simplified excerpt)::
 
     if (desc->irq_data.chip->irq_ack)
-        :c:func:`desc->irq_data.chip->irq_ack`;
+        desc->irq_data.chip->irq_ack();
     handle_irq_event(desc->action);
     if (desc->irq_data.chip->irq_eoi)
-            :c:func:`desc->irq_data.chip->irq_eoi`;
+        desc->irq_data.chip->irq_eoi();
 
 
 EOI Edge IRQ flow handler
-- 
2.15.0

^ permalink raw reply related	[flat|nested] 2+ messages in thread

* Re: [PATCH] genericirq.rst: Remove :c:func:`...` in code blocks
  2017-11-28  5:16 [PATCH] genericirq.rst: Remove :c:func:`...` in code blocks Jonathan Neuschäfer
@ 2017-12-02 15:42 ` Jonathan Corbet
  0 siblings, 0 replies; 2+ messages in thread
From: Jonathan Corbet @ 2017-12-02 15:42 UTC (permalink / raw)
  To: Jonathan Neuschäfer; +Cc: linux-doc, Mauro Carvalho Chehab, linux-kernel

On Tue, 28 Nov 2017 06:16:21 +0100
Jonathan Neuschäfer <j.neuschaefer@gmx.net> wrote:

> In code blocks, :c:func:`...` annotations don't result in
> cross-references. Instead, they are rendered verbatim.  Remove these
> broken annotations, and mark function calls with parentheses() again.
> 
> Fixes: 76d40fae1351 ("genericirq.rst: add cross-reference links and use monospaced fonts")
> Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>

Sigh, I should have noticed that one.  Applied, thanks.

jon

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2017-12-02 15:42 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2017-11-28  5:16 [PATCH] genericirq.rst: Remove :c:func:`...` in code blocks Jonathan Neuschäfer
2017-12-02 15:42 ` Jonathan Corbet

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox