[PATCH] Documentation: kernel-hacking: Remove comma

Thorsten Blum posted 1 patch 1 month, 2 weeks ago
Documentation/kernel-hacking/hacking.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
[PATCH] Documentation: kernel-hacking: Remove comma
Posted by Thorsten Blum 1 month, 2 weeks ago
The comma is wrong, remove it.

Signed-off-by: Thorsten Blum <thorsten.blum@linux.dev>
---
 Documentation/kernel-hacking/hacking.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/kernel-hacking/hacking.rst b/Documentation/kernel-hacking/hacking.rst
index 0042776a9e17..06fcb7c662d3 100644
--- a/Documentation/kernel-hacking/hacking.rst
+++ b/Documentation/kernel-hacking/hacking.rst
@@ -49,7 +49,7 @@ User Context
 
 User context is when you are coming in from a system call or other trap:
 like userspace, you can be preempted by more important tasks and by
-interrupts. You can sleep, by calling :c:func:`schedule()`.
+interrupts. You can sleep by calling :c:func:`schedule()`.
 
 .. note::
 
-- 
Thorsten Blum <thorsten.blum@linux.dev>
GPG: 1D60 735E 8AEF 3BE4 73B6  9D84 7336 78FD 8DFE EAD4
Re: [PATCH] Documentation: kernel-hacking: Remove comma
Posted by Jonathan Corbet 1 month, 2 weeks ago
Thorsten Blum <thorsten.blum@linux.dev> writes:

> The comma is wrong, remove it.
>
> Signed-off-by: Thorsten Blum <thorsten.blum@linux.dev>
> ---
>  Documentation/kernel-hacking/hacking.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/kernel-hacking/hacking.rst b/Documentation/kernel-hacking/hacking.rst
> index 0042776a9e17..06fcb7c662d3 100644
> --- a/Documentation/kernel-hacking/hacking.rst
> +++ b/Documentation/kernel-hacking/hacking.rst
> @@ -49,7 +49,7 @@ User Context
>  
>  User context is when you are coming in from a system call or other trap:
>  like userspace, you can be preempted by more important tasks and by
> -interrupts. You can sleep, by calling :c:func:`schedule()`.
> +interrupts. You can sleep by calling :c:func:`schedule()`.
>  
Applied, thanks,

jon
Re: [PATCH] Documentation: kernel-hacking: Remove comma
Posted by Jonathan Corbet 1 month, 2 weeks ago
Thorsten Blum <thorsten.blum@linux.dev> writes:

> The comma is wrong, remove it.
>
> Signed-off-by: Thorsten Blum <thorsten.blum@linux.dev>
> ---
>  Documentation/kernel-hacking/hacking.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/kernel-hacking/hacking.rst b/Documentation/kernel-hacking/hacking.rst
> index 0042776a9e17..06fcb7c662d3 100644
> --- a/Documentation/kernel-hacking/hacking.rst
> +++ b/Documentation/kernel-hacking/hacking.rst
> @@ -49,7 +49,7 @@ User Context
>  
>  User context is when you are coming in from a system call or other trap:
>  like userspace, you can be preempted by more important tasks and by
> -interrupts. You can sleep, by calling :c:func:`schedule()`.
> +interrupts. You can sleep by calling :c:func:`schedule()`.

That's a fine change, but can I prevail upon you to get rid of the
usless :c:func: annotation while you're playing with that line?

Thanks,

jon
Re: [PATCH] Documentation: kernel-hacking: Remove comma
Posted by Thorsten Blum 1 month, 2 weeks ago
On 19. Dec 2025, at 22:31, Jonathan Corbet wrote:
> Thorsten Blum <thorsten.blum@linux.dev> writes:
>> The comma is wrong, remove it.
>> 
>> Signed-off-by: Thorsten Blum <thorsten.blum@linux.dev>
>> ---
>> Documentation/kernel-hacking/hacking.rst | 2 +-
>> 1 file changed, 1 insertion(+), 1 deletion(-)
>> 
>> diff --git a/Documentation/kernel-hacking/hacking.rst b/Documentation/kernel-hacking/hacking.rst
>> index 0042776a9e17..06fcb7c662d3 100644
>> --- a/Documentation/kernel-hacking/hacking.rst
>> +++ b/Documentation/kernel-hacking/hacking.rst
>> @@ -49,7 +49,7 @@ User Context
>> 
>> User context is when you are coming in from a system call or other trap:
>> like userspace, you can be preempted by more important tasks and by
>> -interrupts. You can sleep, by calling :c:func:`schedule()`.
>> +interrupts. You can sleep by calling :c:func:`schedule()`.
> 
> That's a fine change, but can I prevail upon you to get rid of the
> usless :c:func: annotation while you're playing with that line?

So just `schedule()`?

:c:func: is used very often in the same file - maybe we should remove
them all in a separate patch? I'm fine either way.

Thanks,
Thorsten
Re: [PATCH] Documentation: kernel-hacking: Remove comma
Posted by Jonathan Corbet 1 month, 2 weeks ago
Thorsten Blum <thorsten.blum@linux.dev> writes:

>> That's a fine change, but can I prevail upon you to get rid of the
>> usless :c:func: annotation while you're playing with that line?
>
> So just `schedule()`?

Yes.  We should never use :c:func:, our automarkup code will do the
right thing in its absence.

> :c:func: is used very often in the same file - maybe we should remove
> them all in a separate patch? I'm fine either way.

If you want to do them all, a separate patch probably makes sense.  That
would be wonderful.

Thanks,

jon
Re: [PATCH] Documentation: kernel-hacking: Remove comma
Posted by Randy Dunlap 1 month, 2 weeks ago

On 12/19/25 9:18 AM, Thorsten Blum wrote:
> The comma is wrong, remove it.
> 
> Signed-off-by: Thorsten Blum <thorsten.blum@linux.dev>

Acked-by: Randy Dunlap <rdunlap@infradead.org>

> ---
>  Documentation/kernel-hacking/hacking.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/kernel-hacking/hacking.rst b/Documentation/kernel-hacking/hacking.rst
> index 0042776a9e17..06fcb7c662d3 100644
> --- a/Documentation/kernel-hacking/hacking.rst
> +++ b/Documentation/kernel-hacking/hacking.rst
> @@ -49,7 +49,7 @@ User Context
>  
>  User context is when you are coming in from a system call or other trap:
>  like userspace, you can be preempted by more important tasks and by
> -interrupts. You can sleep, by calling :c:func:`schedule()`.
> +interrupts. You can sleep by calling :c:func:`schedule()`.
>  
>  .. note::
>  

-- 
~Randy