[PATCH v2 07/20] rv/rvgen: fix typos in automata and generator docstring and comments

Wander Lairson Costa posted 20 patches 4 days, 3 hours ago
[PATCH v2 07/20] rv/rvgen: fix typos in automata and generator docstring and comments
Posted by Wander Lairson Costa 4 days, 3 hours ago
Fix two typos in the Automata class documentation that have been
present since the initial implementation. Fix the class
docstring: "part it" instead of "parses it". Additionally, a
comment describing transition labels contained the misspelling
"lables" instead of "labels".

Fix a typo in the comment describing the insertion of the initial
state into the states list: "bein og" should be "beginning of".

Fix typo in the module docstring: "Abtract" should be "Abstract".

Signed-off-by: Wander Lairson Costa <wander@redhat.com>
---
 tools/verification/rvgen/rvgen/automata.py  | 6 +++---
 tools/verification/rvgen/rvgen/generator.py | 2 +-
 2 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/tools/verification/rvgen/rvgen/automata.py b/tools/verification/rvgen/rvgen/automata.py
index 1feb5f0c0bc3e..0d7cbd0c634a9 100644
--- a/tools/verification/rvgen/rvgen/automata.py
+++ b/tools/verification/rvgen/rvgen/automata.py
@@ -18,7 +18,7 @@ class AutomataError(Exception):
     """
 
 class Automata:
-    """Automata class: Reads a dot file and part it as an automata.
+    """Automata class: Reads a dot file and parses it as an automata.
 
     Attributes:
         dot_file: A dot file with an state_automaton definition.
@@ -113,7 +113,7 @@ class Automata:
         states = sorted(set(states))
         states.remove(initial_state)
 
-        # Insert the initial state at the bein og the states
+        # Insert the initial state at the beginning of the states
         states.insert(0, initial_state)
 
         if not has_final_states:
@@ -134,7 +134,7 @@ class Automata:
                 line = self.__dot_lines[cursor].split()
                 event = line[-2].replace('"','')
 
-                # when a transition has more than one lables, they are like this
+                # when a transition has more than one labels, they are like this
                 # "local_irq_enable\nhw_local_irq_enable_n"
                 # so split them.
 
diff --git a/tools/verification/rvgen/rvgen/generator.py b/tools/verification/rvgen/rvgen/generator.py
index ee75e111feef1..a3fbb1ac74916 100644
--- a/tools/verification/rvgen/rvgen/generator.py
+++ b/tools/verification/rvgen/rvgen/generator.py
@@ -3,7 +3,7 @@
 #
 # Copyright (C) 2019-2022 Red Hat, Inc. Daniel Bristot de Oliveira <bristot@kernel.org>
 #
-# Abtract class for generating kernel runtime verification monitors from specification file
+# Abstract class for generating kernel runtime verification monitors from specification file
 
 import platform
 import os
-- 
2.52.0
Re: [PATCH v2 07/20] rv/rvgen: fix typos in automata and generator docstring and comments
Posted by Gabriele Monaco 3 days, 11 hours ago
On Wed, 2026-02-04 at 11:42 -0300, Wander Lairson Costa wrote:
> Fix two typos in the Automata class documentation that have been
> present since the initial implementation. Fix the class
> docstring: "part it" instead of "parses it". Additionally, a
> comment describing transition labels contained the misspelling
> "lables" instead of "labels".
> 
> Fix a typo in the comment describing the insertion of the initial
> state into the states list: "bein og" should be "beginning of".
> 
> Fix typo in the module docstring: "Abtract" should be "Abstract".
> 
> Signed-off-by: Wander Lairson Costa <wander@redhat.com>


While you're at it there are a few singular/plural inconsistencies, see below.

Other than that it looks good, thanks!

Reviewed-by: Gabriele Monaco <gmonaco@redhat.com>


> ---
>  tools/verification/rvgen/rvgen/automata.py  | 6 +++---
>  tools/verification/rvgen/rvgen/generator.py | 2 +-
>  2 files changed, 4 insertions(+), 4 deletions(-)
> 
> diff --git a/tools/verification/rvgen/rvgen/automata.py
> b/tools/verification/rvgen/rvgen/automata.py
> index 1feb5f0c0bc3e..0d7cbd0c634a9 100644
> --- a/tools/verification/rvgen/rvgen/automata.py
> +++ b/tools/verification/rvgen/rvgen/automata.py
> @@ -18,7 +18,7 @@ class AutomataError(Exception):
>      """
>  
>  class Automata:
> -    """Automata class: Reads a dot file and part it as an automata.
> +    """Automata class: Reads a dot file and parses it as an automata.
>  

Automata is plural, the singular is automaton (you can keep the class name
unchanged): 

+    """Automata class: Reads a dot file and parses it as an automaton.

>      Attributes:
>          dot_file: A dot file with an state_automaton definition.
> @@ -113,7 +113,7 @@ class Automata:
>          states = sorted(set(states))
>          states.remove(initial_state)
>  
> -        # Insert the initial state at the bein og the states
> +        # Insert the initial state at the beginning of the states
>          states.insert(0, initial_state)
>  
>          if not has_final_states:
> @@ -134,7 +134,7 @@ class Automata:
>                  line = self.__dot_lines[cursor].split()
>                  event = line[-2].replace('"','')
>  
> -                # when a transition has more than one lables, they are like
> this
> +                # when a transition has more than one labels, they are like
> this

This should be "more than one label" as singular.

>                  # "local_irq_enable\nhw_local_irq_enable_n"
>                  # so split them.
>  
> diff --git a/tools/verification/rvgen/rvgen/generator.py
> b/tools/verification/rvgen/rvgen/generator.py
> index ee75e111feef1..a3fbb1ac74916 100644
> --- a/tools/verification/rvgen/rvgen/generator.py
> +++ b/tools/verification/rvgen/rvgen/generator.py
> @@ -3,7 +3,7 @@
>  #
>  # Copyright (C) 2019-2022 Red Hat, Inc. Daniel Bristot de Oliveira
> <bristot@kernel.org>
>  #
> -# Abtract class for generating kernel runtime verification monitors from
> specification file
> +# Abstract class for generating kernel runtime verification monitors from
> specification file
>  
>  import platform
>  import os
Re: [PATCH v2 07/20] rv/rvgen: fix typos in automata and generator docstring and comments
Posted by Wander Lairson Costa 2 days, 22 hours ago
On Thu, Feb 05, 2026 at 08:03:16AM +0100, Gabriele Monaco wrote:
> On Wed, 2026-02-04 at 11:42 -0300, Wander Lairson Costa wrote:
> > Fix two typos in the Automata class documentation that have been
> > present since the initial implementation. Fix the class
> > docstring: "part it" instead of "parses it". Additionally, a
> > comment describing transition labels contained the misspelling
> > "lables" instead of "labels".
> > 
> > Fix a typo in the comment describing the insertion of the initial
> > state into the states list: "bein og" should be "beginning of".
> > 
> > Fix typo in the module docstring: "Abtract" should be "Abstract".
> > 
> > Signed-off-by: Wander Lairson Costa <wander@redhat.com>
> 
> 
> While you're at it there are a few singular/plural inconsistencies, see below.

Okie dokie. I will update the patch

> 
> Other than that it looks good, thanks!
> 
> Reviewed-by: Gabriele Monaco <gmonaco@redhat.com>
> 
> 
> > ---
> >  tools/verification/rvgen/rvgen/automata.py  | 6 +++---
> >  tools/verification/rvgen/rvgen/generator.py | 2 +-
> >  2 files changed, 4 insertions(+), 4 deletions(-)
> > 
> > diff --git a/tools/verification/rvgen/rvgen/automata.py
> > b/tools/verification/rvgen/rvgen/automata.py
> > index 1feb5f0c0bc3e..0d7cbd0c634a9 100644
> > --- a/tools/verification/rvgen/rvgen/automata.py
> > +++ b/tools/verification/rvgen/rvgen/automata.py
> > @@ -18,7 +18,7 @@ class AutomataError(Exception):
> >      """
> >  
> >  class Automata:
> > -    """Automata class: Reads a dot file and part it as an automata.
> > +    """Automata class: Reads a dot file and parses it as an automata.
> >  
> 
> Automata is plural, the singular is automaton (you can keep the class name
> unchanged): 
> 
> +    """Automata class: Reads a dot file and parses it as an automaton.
> 
> >      Attributes:
> >          dot_file: A dot file with an state_automaton definition.
> > @@ -113,7 +113,7 @@ class Automata:
> >          states = sorted(set(states))
> >          states.remove(initial_state)
> >  
> > -        # Insert the initial state at the bein og the states
> > +        # Insert the initial state at the beginning of the states
> >          states.insert(0, initial_state)
> >  
> >          if not has_final_states:
> > @@ -134,7 +134,7 @@ class Automata:
> >                  line = self.__dot_lines[cursor].split()
> >                  event = line[-2].replace('"','')
> >  
> > -                # when a transition has more than one lables, they are like
> > this
> > +                # when a transition has more than one labels, they are like
> > this
> 
> This should be "more than one label" as singular.
> 
> >                  # "local_irq_enable\nhw_local_irq_enable_n"
> >                  # so split them.
> >  
> > diff --git a/tools/verification/rvgen/rvgen/generator.py
> > b/tools/verification/rvgen/rvgen/generator.py
> > index ee75e111feef1..a3fbb1ac74916 100644
> > --- a/tools/verification/rvgen/rvgen/generator.py
> > +++ b/tools/verification/rvgen/rvgen/generator.py
> > @@ -3,7 +3,7 @@
> >  #
> >  # Copyright (C) 2019-2022 Red Hat, Inc. Daniel Bristot de Oliveira
> > <bristot@kernel.org>
> >  #
> > -# Abtract class for generating kernel runtime verification monitors from
> > specification file
> > +# Abstract class for generating kernel runtime verification monitors from
> > specification file
> >  
> >  import platform
> >  import os
>