Re: [PATCH v2 55/57] docs: irq-domain.rst: Simple improvements

Jiri Slaby
2025-03-20T06:26:18Z

On 19. 03. 25, 18:54, Randy Dunlap wrote:
> Hi,
>
> On 3/19/25 2:29 AM, Jiri Slaby (SUSE) wrote:
>> The improvements include:
>> * Capitals in headlines.
>> * Added commas: for easier reading, it is always desired to add commas
>> at some places in text. Like before adverbs or after fronted
>> sentences.
>> * 3rd person -> add 's' to verbs.
>> * End some sentences with period and start a new one. Avoid thus heavy
>> sentences.
>>
>> Signed-off-by: Jiri Slaby (SUSE) <jirislaby@kernel.org>
>> Cc: Jonathan Corbet <corbet@lwn.net>
>> Cc: linux-doc@vger.kernel.org
>> Cc: Randy Dunlap <rdunlap@infradead.org>
>> ---
>> Documentation/core-api/irq/irq-domain.rst | 22 +++++++++++-----------
>> 1 file changed, 11 insertions(+), 11 deletions(-)
>>
>> diff --git a/Documentation/core-api/irq/irq-domain.rst b/Documentation/core-api/irq/irq-domain.rst
>> index 775dd43b3340..c2f2728b1a35 100644
>> --- a/Documentation/core-api/irq/irq-domain.rst
>> +++ b/Documentation/core-api/irq/irq-domain.rst
>> @@ -1,19 +1,19 @@
>> ===============================================
>> -The irq_domain interrupt number mapping library
>> +The irq_domain Interrupt Number Mapping Library
>> ===============================================
>>
>> The current design of the Linux kernel uses a single large number
>> space where each separate IRQ source is assigned a different number.
>> This is simple when there is only one interrupt controller, but in
>> -systems with multiple interrupt controllers the kernel must ensure
>> +systems with multiple interrupt controllers, the kernel must ensure
>> that each one gets assigned non-overlapping allocations of Linux
>> IRQ numbers.
>>
>
> (I'm OK with all of the changes here except this one:)
>
>> The number of interrupt controllers registered as unique irqchips> -show a rising tendency: for example subdrivers of different kinds
>> +shows a rising tendency. For example, subdrivers of different kinds
>> such as GPIO controllers avoid reimplementing identical callback
>> mechanisms as the IRQ core system by modelling their interrupt
>> -handlers as irqchips, i.e. in effect cascading interrupt controllers.
>> +handlers as irqchips. I.e. in effect cascading interrupt controllers.
>
> I would just add a comma after "i.e.". In the new + line, the "I.e." part
> is not a sentence.

Thanks. Of course, so now, I have:

The number of interrupt controllers registered as unique irqchips
shows a rising tendency. For example, subdrivers of different kinds
such as GPIO controllers avoid reimplementing identical callback
mechanisms as the IRQ core system by modelling their interrupt
handlers as irqchips, i.e., in effect cascading interrupt controllers.

--
js
suse labs