[PATCH] RISC-V: Documentation: Add enough title underlines to CMODX

[PATCH] RISC-V: Documentation: Add enough title underlines to CMODX

[Palmer Dabbelt]

This reports as a warning in linux-next along the lines of

    Documentation/arch/riscv/cmodx.rst:14: WARNING: Title underline too short.

    CMODX in the Kernel Space
    --------------------- [docutils]
    Documentation/arch/riscv/cmodx.rst:43: WARNING: Title underline too short.

    CMODX in the User Space
    --------------------- [docutils]
    Documentation/arch/riscv/cmodx.rst:43: WARNING: Title underline too short.

    CMODX in the User Space
    --------------------- [docutils]

Link: https://lore.kernel.org/all/20250603154544.1602a8b5@canb.auug.org.au/
Fixes: 0e07200b2af6 ("riscv: Documentation: add a description about dynamic ftrace")
Signed-off-by: Palmer Dabbelt <palmer@dabbelt.com>
---
 Documentation/arch/riscv/cmodx.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/arch/riscv/cmodx.rst b/Documentation/arch/riscv/cmodx.rst
index e009873b2d17..40ba53bed5df 100644
--- a/Documentation/arch/riscv/cmodx.rst
+++ b/Documentation/arch/riscv/cmodx.rst
@@ -11,7 +11,7 @@ program must enforce its own synchronization with the unprivileged fence.i
 instruction.
 
 CMODX in the Kernel Space
----------------------
+-------------------------
 
 Dynamic ftrace
 ---------------------
@@ -40,7 +40,7 @@ pacthable function. The metadata is resolved at the first trampoline, then the
 execution can be derect to another custom trampoline.
 
 CMODX in the User Space
----------------------
+-----------------------
 
 Though fence.i is an unprivileged instruction, the default Linux ABI prohibits
 the use of fence.i in userspace applications. At any point the scheduler may
-- 
2.39.5 (Apple Git-154)


_______________________________________________
linux-riscv mailing list
linux-riscv@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-riscv

Re: [PATCH] RISC-V: Documentation: Add enough title underlines to CMODX

[Charlie Jenkins]

On Tue, Jun 03, 2025 at 10:28:57AM -0700, Palmer Dabbelt wrote:
> This reports as a warning in linux-next along the lines of
> 
>     Documentation/arch/riscv/cmodx.rst:14: WARNING: Title underline too short.
> 
>     CMODX in the Kernel Space
>     --------------------- [docutils]
>     Documentation/arch/riscv/cmodx.rst:43: WARNING: Title underline too short.
> 
>     CMODX in the User Space
>     --------------------- [docutils]
>     Documentation/arch/riscv/cmodx.rst:43: WARNING: Title underline too short.
> 
>     CMODX in the User Space
>     --------------------- [docutils]
> 
> Link: https://lore.kernel.org/all/20250603154544.1602a8b5@canb.auug.org.au/
> Fixes: 0e07200b2af6 ("riscv: Documentation: add a description about dynamic ftrace")
> Signed-off-by: Palmer Dabbelt <palmer@dabbelt.com>

Thanks!

Reviewed-by: Charlie Jenkins <charlie@rivosinc.com>

> ---
>  Documentation/arch/riscv/cmodx.rst | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/arch/riscv/cmodx.rst b/Documentation/arch/riscv/cmodx.rst
> index e009873b2d17..40ba53bed5df 100644
> --- a/Documentation/arch/riscv/cmodx.rst
> +++ b/Documentation/arch/riscv/cmodx.rst
> @@ -11,7 +11,7 @@ program must enforce its own synchronization with the unprivileged fence.i
>  instruction.
>  
>  CMODX in the Kernel Space
> ----------------------
> +-------------------------
>  
>  Dynamic ftrace
>  ---------------------
> @@ -40,7 +40,7 @@ pacthable function. The metadata is resolved at the first trampoline, then the
>  execution can be derect to another custom trampoline.
>  
>  CMODX in the User Space
> ----------------------
> +-----------------------
>  
>  Though fence.i is an unprivileged instruction, the default Linux ABI prohibits
>  the use of fence.i in userspace applications. At any point the scheduler may
> -- 
> 2.39.5 (Apple Git-154)
> 
> 
> _______________________________________________
> linux-riscv mailing list
> linux-riscv@lists.infradead.org
> http://lists.infradead.org/mailman/listinfo/linux-riscv

_______________________________________________
linux-riscv mailing list
linux-riscv@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-riscv

Re: [PATCH] RISC-V: Documentation: Add enough title underlines to CMODX

[patchwork-bot+linux-riscv]

Hello:

This patch was applied to riscv/linux.git (for-next)
by Palmer Dabbelt <palmer@dabbelt.com>:

On Tue,  3 Jun 2025 10:28:57 -0700 you wrote:
> This reports as a warning in linux-next along the lines of
> 
>     Documentation/arch/riscv/cmodx.rst:14: WARNING: Title underline too short.
> 
>     CMODX in the Kernel Space
>     --------------------- [docutils]
>     Documentation/arch/riscv/cmodx.rst:43: WARNING: Title underline too short.
> 
> [...]

Here is the summary with links:
  - RISC-V: Documentation: Add enough title underlines to CMODX
    https://git.kernel.org/riscv/c/a146ae2a60be

You are awesome, thank you!
-- 
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html



_______________________________________________
linux-riscv mailing list
linux-riscv@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-riscv