2021-08-13 14:50:26

by Changbin Du

[permalink] [raw]
Subject: [PATCH] Documentation: in_irq() cleanup

Replace the obsolete and ambiguos macro in_irq() with new
macro in_hardirq().

Signed-off-by: Changbin Du <[email protected]>
---
Documentation/kernel-hacking/hacking.rst | 2 +-
Documentation/kernel-hacking/locking.rst | 4 ++--
Documentation/translations/it_IT/kernel-hacking/hacking.rst | 2 +-
Documentation/translations/it_IT/kernel-hacking/locking.rst | 4 ++--
Documentation/translations/zh_CN/kernel-hacking/hacking.rst | 2 +-
5 files changed, 7 insertions(+), 7 deletions(-)

diff --git a/Documentation/kernel-hacking/hacking.rst b/Documentation/kernel-hacking/hacking.rst
index df65c19aa7df..f514cec8e16b 100644
--- a/Documentation/kernel-hacking/hacking.rst
+++ b/Documentation/kernel-hacking/hacking.rst
@@ -77,7 +77,7 @@ fast: frequently it simply acknowledges the interrupt, marks a 'software
interrupt' for execution and exits.

You can tell you are in a hardware interrupt, because
-:c:func:`in_irq()` returns true.
+:c:func:`in_hardirq()` returns true.

.. warning::

diff --git a/Documentation/kernel-hacking/locking.rst b/Documentation/kernel-hacking/locking.rst
index ed1284c6f078..94232ed1d592 100644
--- a/Documentation/kernel-hacking/locking.rst
+++ b/Documentation/kernel-hacking/locking.rst
@@ -1406,7 +1406,7 @@ bh
half will be running at any time.

Hardware Interrupt / Hardware IRQ
- Hardware interrupt request. in_irq() returns true in a
+ Hardware interrupt request. in_hardirq() returns true in a
hardware interrupt handler.

Interrupt Context
@@ -1418,7 +1418,7 @@ SMP
(``CONFIG_SMP=y``).

Software Interrupt / softirq
- Software interrupt handler. in_irq() returns false;
+ Software interrupt handler. in_hardirq() returns false;
in_softirq() returns true. Tasklets and softirqs both
fall into the category of 'software interrupts'.

diff --git a/Documentation/translations/it_IT/kernel-hacking/hacking.rst b/Documentation/translations/it_IT/kernel-hacking/hacking.rst
index f6beb385b4ac..a2474e1f235e 100644
--- a/Documentation/translations/it_IT/kernel-hacking/hacking.rst
+++ b/Documentation/translations/it_IT/kernel-hacking/hacking.rst
@@ -90,7 +90,7 @@ i gestori d'interruzioni devono essere veloci: spesso si limitano
esclusivamente a notificare la presa in carico dell'interruzione,
programmare una 'interruzione software' per l'esecuzione e quindi terminare.

-Potete dire d'essere in una interruzione hardware perché :c:func:`in_irq()`
+Potete dire d'essere in una interruzione hardware perché :c:func:`in_hardirq()`
ritorna vero.

.. warning::
diff --git a/Documentation/translations/it_IT/kernel-hacking/locking.rst b/Documentation/translations/it_IT/kernel-hacking/locking.rst
index 1e7c84def369..1efb8293bf1f 100644
--- a/Documentation/translations/it_IT/kernel-hacking/locking.rst
+++ b/Documentation/translations/it_IT/kernel-hacking/locking.rst
@@ -1459,11 +1459,11 @@ contesto utente
che hardware.

interruzione hardware
- Richiesta di interruzione hardware. in_irq() ritorna vero in un
+ Richiesta di interruzione hardware. in_hardirq() ritorna vero in un
gestore d'interruzioni hardware.

interruzione software / softirq
- Gestore di interruzioni software: in_irq() ritorna falso;
+ Gestore di interruzioni software: in_hardirq() ritorna falso;
in_softirq() ritorna vero. I tasklet e le softirq sono entrambi
considerati 'interruzioni software'.

diff --git a/Documentation/translations/zh_CN/kernel-hacking/hacking.rst b/Documentation/translations/zh_CN/kernel-hacking/hacking.rst
index ab974faddecf..877921adb5bb 100644
--- a/Documentation/translations/zh_CN/kernel-hacking/hacking.rst
+++ b/Documentation/translations/zh_CN/kernel-hacking/hacking.rst
@@ -68,7 +68,7 @@
它将被排队(或丢弃)。因为它会关闭中断,所以处理程序必须很快:通常它只是
确认中断,标记一个“软件中断”以执行并退出。

-您可以通过 :c:func:`in_irq()` 返回真来判断您处于硬件中断状态。
+您可以通过 :c:func:`in_hardirq()` 返回真来判断您处于硬件中断状态。

.. warning::

--
2.30.2


2021-08-13 15:47:14

by Jonathan Corbet

[permalink] [raw]
Subject: Re: [PATCH] Documentation: in_irq() cleanup

Changbin Du <[email protected]> writes:

> Replace the obsolete and ambiguos macro in_irq() with new
> macro in_hardirq().
>
> Signed-off-by: Changbin Du <[email protected]>
> ---
> Documentation/kernel-hacking/hacking.rst | 2 +-
> Documentation/kernel-hacking/locking.rst | 4 ++--
> Documentation/translations/it_IT/kernel-hacking/hacking.rst | 2 +-
> Documentation/translations/it_IT/kernel-hacking/locking.rst | 4 ++--
> Documentation/translations/zh_CN/kernel-hacking/hacking.rst | 2 +-
> 5 files changed, 7 insertions(+), 7 deletions(-)
>
> diff --git a/Documentation/kernel-hacking/hacking.rst b/Documentation/kernel-hacking/hacking.rst
> index df65c19aa7df..f514cec8e16b 100644
> --- a/Documentation/kernel-hacking/hacking.rst
> +++ b/Documentation/kernel-hacking/hacking.rst
> @@ -77,7 +77,7 @@ fast: frequently it simply acknowledges the interrupt, marks a 'software
> interrupt' for execution and exits.
>
> You can tell you are in a hardware interrupt, because
> -:c:func:`in_irq()` returns true.
> +:c:func:`in_hardirq()` returns true.

While you're in the neighborhood, can you please get rid of the :c:func:
markup? We've not needed that for some time now; simply saying
in_hardirq() is sufficient.

Thanks,

jon

2021-08-14 01:46:13

by Changbin Du

[permalink] [raw]
Subject: Re: [PATCH] Documentation: in_irq() cleanup

On Fri, Aug 13, 2021 at 09:44:28AM -0600, Jonathan Corbet wrote:
> Changbin Du <[email protected]> writes:
>
> > Replace the obsolete and ambiguos macro in_irq() with new
> > macro in_hardirq().
> >
> > Signed-off-by: Changbin Du <[email protected]>
> > ---
> > Documentation/kernel-hacking/hacking.rst | 2 +-
> > Documentation/kernel-hacking/locking.rst | 4 ++--
> > Documentation/translations/it_IT/kernel-hacking/hacking.rst | 2 +-
> > Documentation/translations/it_IT/kernel-hacking/locking.rst | 4 ++--
> > Documentation/translations/zh_CN/kernel-hacking/hacking.rst | 2 +-
> > 5 files changed, 7 insertions(+), 7 deletions(-)
> >
> > diff --git a/Documentation/kernel-hacking/hacking.rst b/Documentation/kernel-hacking/hacking.rst
> > index df65c19aa7df..f514cec8e16b 100644
> > --- a/Documentation/kernel-hacking/hacking.rst
> > +++ b/Documentation/kernel-hacking/hacking.rst
> > @@ -77,7 +77,7 @@ fast: frequently it simply acknowledges the interrupt, marks a 'software
> > interrupt' for execution and exits.
> >
> > You can tell you are in a hardware interrupt, because
> > -:c:func:`in_irq()` returns true.
> > +:c:func:`in_hardirq()` returns true.
>
> While you're in the neighborhood, can you please get rid of the :c:func:
> markup? We've not needed that for some time now; simply saying
> in_hardirq() is sufficient.
>
No problem, will updaate it soon.

> Thanks,
>
> jon

--
Cheers,
Changbin Du