Issue in man page PR_RISCV_SET_ICACHE_FLUSH_CTX.2const

Issue in man page PR_RISCV_SET_ICACHE_FLUSH_CTX.2const

[Helge Kreutzmann]

Without further ado, the following was found:

Issue:     No full stop

"PR_RISCV_SET_ICACHE_FLUSH_CTX - Enable/disable icache flushing instructions "
"in userspace."

Re: Issue in man page PR_RISCV_SET_ICACHE_FLUSH_CTX.2const

[Alejandro Colomar]

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

On Wed, Dec 24, 2025 at 02:38:22PM +0000, Helge Kreutzmann wrote:
> Without further ado, the following was found:
> 
> Issue:     No full stop
> 
> "PR_RISCV_SET_ICACHE_FLUSH_CTX - Enable/disable icache flushing instructions "
> "in userspace."

Thanks!  I've applied a fix.


Cheers,
Alex

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

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

Issue in man page PR_RISCV_SET_ICACHE_FLUSH_CTX.2const

[Helge Kreutzmann]

Without further ado, the following was found:

Issue:     cmodx.c → I<cmodx.c>

"Program source: cmodx.c"

Issue in man page PR_RISCV_SET_ICACHE_FLUSH_CTX.2const

[Helge Kreutzmann]

Without further ado, the following was found:

Issue:     scope → I<scope>

"When scope is set to B<PR_RISCV_SCOPE_PER_PROCESS> all threads in the "
"process are permitted to emit icache flushing instructions.  Whenever any "
"thread in the process is migrated, the corresponding hart's icache will be "
"guaranteed to be consistent with instruction storage.  This does not enforce "
"any guarantees outside of migration.  If a thread modifies an instruction "
"that another thread may attempt to execute, the other thread must still emit "
"an icache flushing instruction before attempting to execute the potentially "
"modified instruction.  This must be performed by the user-space program."

Re: Issue in man page PR_RISCV_SET_ICACHE_FLUSH_CTX.2const

[Alejandro Colomar]

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

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

Fixed; thanks!


> 
> "When scope is set to B<PR_RISCV_SCOPE_PER_PROCESS> all threads in the "
> "process are permitted to emit icache flushing instructions.  Whenever any "
> "thread in the process is migrated, the corresponding hart's icache will be "
> "guaranteed to be consistent with instruction storage.  This does not enforce "
> "any guarantees outside of migration.  If a thread modifies an instruction "
> "that another thread may attempt to execute, the other thread must still emit "
> "an icache flushing instruction before attempting to execute the potentially "
> "modified instruction.  This must be performed by the user-space program."

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

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

Issue in man page PR_RISCV_SET_ICACHE_FLUSH_CTX.2const

[Helge Kreutzmann]

Without further ado, the following was found:

Issue:     eg. → e.g., but I think i.e. is correct?

"In per-thread context (eg., scope is set to B<PR_RISCV_SCOPE_PER_THREAD>)  "
"only the thread calling this function is permitted to emit icache flushing "
"instructions.  When the thread is migrated, the corresponding hart's icache "
"will be guaranteed to be consistent with instruction storage."

Re: Issue in man page PR_RISCV_SET_ICACHE_FLUSH_CTX.2const

[Alejandro Colomar]

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

On Wed, Dec 24, 2025 at 02:38:22PM +0000, Helge Kreutzmann wrote:
> Without further ado, the following was found:
> 
> Issue:     eg. → e.g., but I think i.e. is correct?

Thanks!  Fixed.  Indeed, 'i.e.' is the right thing to use here.


Cheers,
Alex

> 
> "In per-thread context (eg., scope is set to B<PR_RISCV_SCOPE_PER_THREAD>)  "
> "only the thread calling this function is permitted to emit icache flushing "
> "instructions.  When the thread is migrated, the corresponding hart's icache "
> "will be guaranteed to be consistent with instruction storage."

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

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

Issue in man page PR_RISCV_SET_ICACHE_FLUSH_CTX.2const

[Helge Kreutzmann]

Without further ado, the following was found:

Issue:     cmodx.S → I<cmodx.S>

"Program source: cmodx.S"

Issue in man page PR_RISCV_SET_ICACHE_FLUSH_CTX.2const

[Helge Kreutzmann]

Without further ado, the following was found:

Issue 1:   modify_instruction() → B<modify_instruction()>
Issue 2:   get_value() → B<get_value()>

"The following files are meant to be compiled and linked with each other.  "
"The modify_instruction() function replaces an add with zero with an add with "
"one, causing the instruction sequence in get_value() to change from "
"returning a zero to returning a one."

Re: Issue in man page PR_RISCV_SET_ICACHE_FLUSH_CTX.2const

[Alejandro Colomar]

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

Hi Helge,

On Wed, Dec 24, 2025 at 02:38:22PM +0000, Helge Kreutzmann wrote:
> Without further ado, the following was found:
> 
> Issue 1:   modify_instruction() → B<modify_instruction()>
> Issue 2:   get_value() → B<get_value()>
> 
> "The following files are meant to be compiled and linked with each other.  "
> "The modify_instruction() function replaces an add with zero with an add with "
> "one, causing the instruction sequence in get_value() to change from "
> "returning a zero to returning a one."

Since these functions are just part of this example, and not something
standard nor provided by any library nor documented anywhere, I think we
shouldn't mark them up.


Have a lovely night!
Alex

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

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