[PATCH v2] jobserver: Fix typo in docstring

Ricardo Ungerer posted 1 patch 3 weeks ago
tools/lib/python/jobserver.py | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
[PATCH v2] jobserver: Fix typo in docstring
Posted by Ricardo Ungerer 3 weeks ago
This commit fixes small typos in the docstring of jobserver.py.

Signed-off-by: Ricardo Ungerer <ungerer.ricardo@gmail.com>
---
Changes in v2:
- Fix a Sphynx regression created by v1 when removed the second colon.
---
 tools/lib/python/jobserver.py | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/tools/lib/python/jobserver.py b/tools/lib/python/jobserver.py
index aba22c33393d..0b1ffdf9f7a3 100755
--- a/tools/lib/python/jobserver.py
+++ b/tools/lib/python/jobserver.py
@@ -8,14 +8,14 @@
 """
 Interacts with the POSIX jobserver during the Kernel build time.
 
-A "normal" jobserver task, like the one initiated by a make subrocess would do:
+A "normal" jobserver task, like the one initiated by a make subprocess would do:
 
     - open read/write file descriptors to communicate with the job server;
     - ask for one slot by calling::
 
         claim = os.read(reader, 1)
 
-    - when the job finshes, call::
+    - when the job finishes, call::
 
         os.write(writer, b"+")  # os.write(writer, claim)
 
-- 
2.43.0
Re: [PATCH v2] jobserver: Fix typo in docstring
Posted by Jonathan Corbet 2 weeks, 6 days ago
Ricardo Ungerer <ungerer.ricardo@gmail.com> writes:

> This commit fixes small typos in the docstring of jobserver.py.

For future reference, our guidance says to avoid "this commit", and some
maintainers are pretty firm about that.

> Signed-off-by: Ricardo Ungerer <ungerer.ricardo@gmail.com>
> ---
> Changes in v2:
> - Fix a Sphynx regression created by v1 when removed the second colon.
> ---
>  tools/lib/python/jobserver.py | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/tools/lib/python/jobserver.py b/tools/lib/python/jobserver.py
> index aba22c33393d..0b1ffdf9f7a3 100755
> --- a/tools/lib/python/jobserver.py
> +++ b/tools/lib/python/jobserver.py
> @@ -8,14 +8,14 @@
>  """
>  Interacts with the POSIX jobserver during the Kernel build time.
>  
> -A "normal" jobserver task, like the one initiated by a make subrocess would do:
> +A "normal" jobserver task, like the one initiated by a make subprocess would do:
>  
>      - open read/write file descriptors to communicate with the job server;
>      - ask for one slot by calling::
>  
>          claim = os.read(reader, 1)
>  
> -    - when the job finshes, call::
> +    - when the job finishes, call::
>  

Applied, thanks.

jon