Linux-RISC-V Archive on lore.kernel.org
 help / color / mirror / Atom feed
* [PATCH] riscv: Docs: fix unmatched quote warning
@ 2026-04-06 23:23 Randy Dunlap
  2026-05-05 19:58 ` Randy Dunlap
  0 siblings, 1 reply; 4+ messages in thread
From: Randy Dunlap @ 2026-04-06 23:23 UTC (permalink / raw)
  To: linux-kernel
  Cc: Randy Dunlap, Deepak Gupta, Paul Walmsley, Palmer Dabbelt,
	Albert Ou, Alexandre Ghiti, linux-riscv, Jonathan Corbet,
	Shuah Khan, linux-doc

'make htmldocs' complains about ``prctrl` -- so add a second '`' to
avoid the warning.

Documentation/arch/riscv/zicfilp.rst:79: WARNING: Inline literal start-string without end-string. [docutils]

Fixes: 08ee1559052b ("prctl: cfi: change the branch landing pad prctl()s to be more descriptive")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Deepak Gupta <debug@rivosinc.com>
Cc: Paul Walmsley <pjw@kernel.org>
Cc: Palmer Dabbelt <palmer@dabbelt.com>
Cc: Albert Ou <aou@eecs.berkeley.edu>
Cc: Alexandre Ghiti <alex@ghiti.fr>
Cc: linux-riscv@lists.infradead.org
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Shuah Khan <skhan@linuxfoundation.org>
Cc: linux-doc@vger.kernel.org

 Documentation/arch/riscv/zicfilp.rst |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

--- linux-next-20260406.orig/Documentation/arch/riscv/zicfilp.rst
+++ linux-next-20260406/Documentation/arch/riscv/zicfilp.rst
@@ -78,7 +78,7 @@ the program.
 
 Per-task indirect branch tracking state can be monitored and
 controlled via the :c:macro:`PR_GET_CFI` and :c:macro:`PR_SET_CFI`
-``prctl()` arguments (respectively), by supplying
+``prctl()`` arguments (respectively), by supplying
 :c:macro:`PR_CFI_BRANCH_LANDING_PADS` as the second argument.  These
 are architecture-agnostic, and will return -EINVAL if the underlying
 functionality is not supported.

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

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [PATCH] riscv: Docs: fix unmatched quote warning
  2026-04-06 23:23 [PATCH] riscv: Docs: fix unmatched quote warning Randy Dunlap
@ 2026-05-05 19:58 ` Randy Dunlap
  2026-05-13 23:14   ` Randy Dunlap
  0 siblings, 1 reply; 4+ messages in thread
From: Randy Dunlap @ 2026-05-05 19:58 UTC (permalink / raw)
  To: linux-kernel
  Cc: Deepak Gupta, Paul Walmsley, Palmer Dabbelt, Albert Ou,
	Alexandre Ghiti, linux-riscv, Jonathan Corbet, Shuah Khan,
	linux-doc

ping?

On 4/6/26 4:23 PM, Randy Dunlap wrote:
> 'make htmldocs' complains about ``prctrl` -- so add a second '`' to
> avoid the warning.
> 
> Documentation/arch/riscv/zicfilp.rst:79: WARNING: Inline literal start-string without end-string. [docutils]
> 
> Fixes: 08ee1559052b ("prctl: cfi: change the branch landing pad prctl()s to be more descriptive")
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> ---
> Cc: Deepak Gupta <debug@rivosinc.com>
> Cc: Paul Walmsley <pjw@kernel.org>
> Cc: Palmer Dabbelt <palmer@dabbelt.com>
> Cc: Albert Ou <aou@eecs.berkeley.edu>
> Cc: Alexandre Ghiti <alex@ghiti.fr>
> Cc: linux-riscv@lists.infradead.org
> Cc: Jonathan Corbet <corbet@lwn.net>
> Cc: Shuah Khan <skhan@linuxfoundation.org>
> Cc: linux-doc@vger.kernel.org
> 
>  Documentation/arch/riscv/zicfilp.rst |    2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> --- linux-next-20260406.orig/Documentation/arch/riscv/zicfilp.rst
> +++ linux-next-20260406/Documentation/arch/riscv/zicfilp.rst
> @@ -78,7 +78,7 @@ the program.
>  
>  Per-task indirect branch tracking state can be monitored and
>  controlled via the :c:macro:`PR_GET_CFI` and :c:macro:`PR_SET_CFI`
> -``prctl()` arguments (respectively), by supplying
> +``prctl()`` arguments (respectively), by supplying
>  :c:macro:`PR_CFI_BRANCH_LANDING_PADS` as the second argument.  These
>  are architecture-agnostic, and will return -EINVAL if the underlying
>  functionality is not supported.
> 

-- 
~Randy


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

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [PATCH] riscv: Docs: fix unmatched quote warning
  2026-05-05 19:58 ` Randy Dunlap
@ 2026-05-13 23:14   ` Randy Dunlap
  2026-05-14  4:16     ` Paul Walmsley
  0 siblings, 1 reply; 4+ messages in thread
From: Randy Dunlap @ 2026-05-13 23:14 UTC (permalink / raw)
  To: linux-kernel
  Cc: Deepak Gupta, Paul Walmsley, Palmer Dabbelt, Albert Ou,
	Alexandre Ghiti, linux-riscv, Jonathan Corbet, Shuah Khan,
	linux-doc

Hi,
This docs build warning is now in mainline.
Should I ask Jon to merge the patch, given no activity on it?
Thanks.


On 5/5/26 12:58 PM, Randy Dunlap wrote:
> ping?
> 
> On 4/6/26 4:23 PM, Randy Dunlap wrote:
>> 'make htmldocs' complains about ``prctrl` -- so add a second '`' to
>> avoid the warning.
>>
>> Documentation/arch/riscv/zicfilp.rst:79: WARNING: Inline literal start-string without end-string. [docutils]
>>
>> Fixes: 08ee1559052b ("prctl: cfi: change the branch landing pad prctl()s to be more descriptive")
>> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
>> ---
>> Cc: Deepak Gupta <debug@rivosinc.com>
>> Cc: Paul Walmsley <pjw@kernel.org>
>> Cc: Palmer Dabbelt <palmer@dabbelt.com>
>> Cc: Albert Ou <aou@eecs.berkeley.edu>
>> Cc: Alexandre Ghiti <alex@ghiti.fr>
>> Cc: linux-riscv@lists.infradead.org
>> Cc: Jonathan Corbet <corbet@lwn.net>
>> Cc: Shuah Khan <skhan@linuxfoundation.org>
>> Cc: linux-doc@vger.kernel.org
>>
>>  Documentation/arch/riscv/zicfilp.rst |    2 +-
>>  1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> --- linux-next-20260406.orig/Documentation/arch/riscv/zicfilp.rst
>> +++ linux-next-20260406/Documentation/arch/riscv/zicfilp.rst
>> @@ -78,7 +78,7 @@ the program.
>>  
>>  Per-task indirect branch tracking state can be monitored and
>>  controlled via the :c:macro:`PR_GET_CFI` and :c:macro:`PR_SET_CFI`
>> -``prctl()` arguments (respectively), by supplying
>> +``prctl()`` arguments (respectively), by supplying
>>  :c:macro:`PR_CFI_BRANCH_LANDING_PADS` as the second argument.  These
>>  are architecture-agnostic, and will return -EINVAL if the underlying
>>  functionality is not supported.
>>
> 

-- 
~Randy


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

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [PATCH] riscv: Docs: fix unmatched quote warning
  2026-05-13 23:14   ` Randy Dunlap
@ 2026-05-14  4:16     ` Paul Walmsley
  0 siblings, 0 replies; 4+ messages in thread
From: Paul Walmsley @ 2026-05-14  4:16 UTC (permalink / raw)
  To: Randy Dunlap
  Cc: linux-kernel, Deepak Gupta, Paul Walmsley, Palmer Dabbelt,
	Albert Ou, Alexandre Ghiti, linux-riscv, Jonathan Corbet,
	Shuah Khan, linux-doc

Hi Randy,

On Wed, 13 May 2026, Randy Dunlap wrote:

> This docs build warning is now in mainline.
> Should I ask Jon to merge the patch, given no activity on it?

Sorry about the delay; I'll pick it up as a fix.


thanks,

- Paul

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

^ permalink raw reply	[flat|nested] 4+ messages in thread

end of thread, other threads:[~2026-05-14  4:17 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-04-06 23:23 [PATCH] riscv: Docs: fix unmatched quote warning Randy Dunlap
2026-05-05 19:58 ` Randy Dunlap
2026-05-13 23:14   ` Randy Dunlap
2026-05-14  4:16     ` Paul Walmsley

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox