Issue in man page __riscv_flush_icache.3

Issue in man page __riscv_flush_icache.3

[Helge Kreutzmann]

Without further ado, the following was found:

Issue:     flag bits → I<flag> bits

"The I<flags> argument controls the extent of this ordering, with the default "
"behavior (a I<flags> value of 0)  being to enforce the fence on all threads "
"in the current process.  Setting the B<SYS_RISCV_FLUSH_ICACHE_LOCAL> bit "
"allows users to indicate that enforcing ordering on only the current thread "
"is necessary.  All other flag bits are reserved."

Re: Issue in man page __riscv_flush_icache.3

[Alejandro Colomar]

[-- Attachment #1: Type: text/plain, Size: 758 bytes --]

Hi Helge,

On Wed, Dec 24, 2025 at 02:38:24PM +0000, Helge Kreutzmann wrote:
> Without further ado, the following was found:
> 
> Issue:     flag bits → I<flag> bits

The parameter is 'flags', not 'flag'.  Thus, 'flag' can only be the
English word, and thus not be in italics.  The text is correct.


Cheers,
Alex

> 
> "The I<flags> argument controls the extent of this ordering, with the default "
> "behavior (a I<flags> value of 0)  being to enforce the fence on all threads "
> "in the current process.  Setting the B<SYS_RISCV_FLUSH_ICACHE_LOCAL> bit "
> "allows users to indicate that enforcing ordering on only the current thread "
> "is necessary.  All other flag bits are reserved."

-- 
<https://www.alejandro-colomar.es>

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

Re: Issue in man page __riscv_flush_icache.3

[Helge Kreutzmann]

[-- Attachment #1: Type: text/plain, Size: 1503 bytes --]

Hello Alex,
Am Thu, Dec 25, 2025 at 02:34:48PM +0100 schrieb Alejandro Colomar:
> On Wed, Dec 24, 2025 at 02:38:24PM +0000, Helge Kreutzmann wrote:
> > Without further ado, the following was found:
> > 
> > Issue:     flag bits → I<flag> bits
> 
> The parameter is 'flags', not 'flag'.  Thus, 'flag' can only be the
> English word, and thus not be in italics.  The text is correct.


> > "The I<flags> argument controls the extent of this ordering, with the default "
> > "behavior (a I<flags> value of 0)  being to enforce the fence on all threads "
> > "in the current process.  Setting the B<SYS_RISCV_FLUSH_ICACHE_LOCAL> bit "
> > "allows users to indicate that enforcing ordering on only the current thread "
> > "is necessary.  All other flag bits are reserved."

So this is not referring to the variable <flags>?

(Yes, I forgot to add the "s" myself).

If it does refer to this variable you might resolve this by rewording:

All other bits stored in the argument I<flags> are reserved.

Btw. in the German translations team there used to be some discussions
if you could switch (add/remove) a genetiv or plural "s" to suite the
the grammar.

Greetings

          Helge

-- 
      Dr. Helge Kreutzmann                     debian@helgefjell.de
           Dipl.-Phys.                   http://www.helgefjell.de/debian.php
        64bit GNU powered                     gpg signed mail preferred
           Help keep free software "libre": http://www.ffii.de/

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

Re: Issue in man page __riscv_flush_icache.3

[Alejandro Colomar]

[-- Attachment #1: Type: text/plain, Size: 2052 bytes --]

Hi Helge,

On Fri, Dec 26, 2025 at 04:54:50AM +0000, Helge Kreutzmann wrote:
> Hello Alex,
> Am Thu, Dec 25, 2025 at 02:34:48PM +0100 schrieb Alejandro Colomar:
> > On Wed, Dec 24, 2025 at 02:38:24PM +0000, Helge Kreutzmann wrote:
> > > Without further ado, the following was found:
> > > 
> > > Issue:     flag bits → I<flag> bits
> > 
> > The parameter is 'flags', not 'flag'.  Thus, 'flag' can only be the
> > English word, and thus not be in italics.  The text is correct.
> 
> 
> > > "The I<flags> argument controls the extent of this ordering, with the default "
> > > "behavior (a I<flags> value of 0)  being to enforce the fence on all threads "
> > > "in the current process.  Setting the B<SYS_RISCV_FLUSH_ICACHE_LOCAL> bit "
> > > "allows users to indicate that enforcing ordering on only the current thread "
> > > "is necessary.  All other flag bits are reserved."
> 
> So this is not referring to the variable <flags>?
> 
> (Yes, I forgot to add the "s" myself).
> 
> If it does refer to this variable you might resolve this by rewording:
> 
> All other bits stored in the argument I<flags> are reserved.

Yes, that would be appropriate, and would help the reader.  I'll change
it.  Thanks for the suggestion!

> Btw. in the German translations team there used to be some discussions
> if you could switch (add/remove) a genetiv or plural "s" to suite the
> the grammar.

I would never change the spelling of an identifier used in code.  I'd
certainly never remove it.  If you add it, at least the plural should
not be in italics, so that the identifier can still be identified.


Have a lovely day!
Alex

> Greetings
> 
>           Helge
> 
> -- 
>       Dr. Helge Kreutzmann                     debian@helgefjell.de
>            Dipl.-Phys.                   http://www.helgefjell.de/debian.php
>         64bit GNU powered                     gpg signed mail preferred
>            Help keep free software "libre": http://www.ffii.de/



-- 
<https://www.alejandro-colomar.es>

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

Re: Issue in man page __riscv_flush_icache.3

[Helge Kreutzmann]

[-- Attachment #1: Type: text/plain, Size: 950 bytes --]

Hello Alex,
Am Fri, Dec 26, 2025 at 11:46:30AM +0100 schrieb Alejandro Colomar:
> On Fri, Dec 26, 2025 at 04:54:50AM +0000, Helge Kreutzmann wrote:
> > Btw. in the German translations team there used to be some discussions
> > if you could switch (add/remove) a genetiv or plural "s" to suite the
> > the grammar.
> 
> I would never change the spelling of an identifier used in code.  I'd
> certainly never remove it.  If you add it, at least the plural should
> not be in italics, so that the identifier can still be identified.

Don't worry, I won't do it; it was another member of the German
translation team. 

Greetings

         Helge

-- 
      Dr. Helge Kreutzmann                     debian@helgefjell.de
           Dipl.-Phys.                   http://www.helgefjell.de/debian.php
        64bit GNU powered                     gpg signed mail preferred
           Help keep free software "libre": http://www.ffii.de/

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]