[PATCH v2 2/5] tests/guest-debug: Format comments

Gustavo Romero posted 5 patches 1 day, 22 hours ago
Maintainers: Paolo Bonzini <pbonzini@redhat.com>, "Alex Bennée" <alex.bennee@linaro.org>, Thomas Huth <thuth@redhat.com>, "Marc-André Lureau" <marcandre.lureau@redhat.com>, "Daniel P. Berrangé" <berrange@redhat.com>, "Philippe Mathieu-Daudé" <philmd@linaro.org>, Zhao Liu <zhao1.liu@intel.com>
[PATCH v2 2/5] tests/guest-debug: Format comments
Posted by Gustavo Romero 1 day, 22 hours ago
Capitalize and add periods to comments.

Signed-off-by: Gustavo Romero <gustavo.romero@linaro.org>
---
 tests/guest-debug/run-test.py | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

diff --git a/tests/guest-debug/run-test.py b/tests/guest-debug/run-test.py
index d21a5dda77..e051e8947c 100755
--- a/tests/guest-debug/run-test.py
+++ b/tests/guest-debug/run-test.py
@@ -54,7 +54,7 @@ def log(output, msg):
 if __name__ == '__main__':
     args = get_args()
 
-    # Search for a gdb we can use
+    # Search for a gdb we can use.
     if not args.gdb:
         args.gdb = shutil.which("gdb-multiarch")
     if not args.gdb:
@@ -94,22 +94,22 @@ def log(output, msg):
         log(output, "QEMU CMD: %s" % (cmd))
         inferior = subprocess.Popen(shlex.split(cmd))
 
-    # Now launch gdb with our test and collect the result
+    # Now launch gdb with our test and collect the result.
     gdb_cmd = args.gdb
     if args.binary:
         gdb_cmd += " %s" % (args.binary)
     if args.gdb_args:
         gdb_cmd += " %s" % (args.gdb_args)
-    # run quietly and ignore .gdbinit
+    # Run quietly and ignore .gdbinit.
     gdb_cmd += " -q -n -batch"
-    # disable pagination
+    # Disable pagination.
     gdb_cmd += " -ex 'set pagination off'"
-    # disable prompts in case of crash
+    # Disable prompts in case of crash.
     gdb_cmd += " -ex 'set confirm off'"
-    # connect to remote
+    # Connect automatically to remote only if QEMU is launched.
     if args.qemu:
         gdb_cmd += " -ex 'target remote %s'" % (socket_name)
-    # finally the test script itself
+    # Finally the test script itself.
     if args.test:
         argv = [args.test] + args.test_args
         gdb_cmd += f" -ex \"py sys.argv={argv}\""
-- 
2.34.1
Re: [PATCH v2 2/5] tests/guest-debug: Format comments
Posted by Alex Bennée 1 day, 7 hours ago
Gustavo Romero <gustavo.romero@linaro.org> writes:

> Capitalize and add periods to comments.
>
> Signed-off-by: Gustavo Romero <gustavo.romero@linaro.org>

Reviewed-by: Alex Bennée <alex.bennee@linaro.org>

> ---
>  tests/guest-debug/run-test.py | 14 +++++++-------
>  1 file changed, 7 insertions(+), 7 deletions(-)
>
> diff --git a/tests/guest-debug/run-test.py b/tests/guest-debug/run-test.py
> index d21a5dda77..e051e8947c 100755
> --- a/tests/guest-debug/run-test.py
> +++ b/tests/guest-debug/run-test.py
> @@ -54,7 +54,7 @@ def log(output, msg):
>  if __name__ == '__main__':
>      args = get_args()
>  
> -    # Search for a gdb we can use
> +    # Search for a gdb we can use.
>      if not args.gdb:
>          args.gdb = shutil.which("gdb-multiarch")
>      if not args.gdb:
> @@ -94,22 +94,22 @@ def log(output, msg):
>          log(output, "QEMU CMD: %s" % (cmd))
>          inferior = subprocess.Popen(shlex.split(cmd))
>  
> -    # Now launch gdb with our test and collect the result
> +    # Now launch gdb with our test and collect the result.
>      gdb_cmd = args.gdb
>      if args.binary:
>          gdb_cmd += " %s" % (args.binary)
>      if args.gdb_args:
>          gdb_cmd += " %s" % (args.gdb_args)
> -    # run quietly and ignore .gdbinit
> +    # Run quietly and ignore .gdbinit.
>      gdb_cmd += " -q -n -batch"
> -    # disable pagination
> +    # Disable pagination.
>      gdb_cmd += " -ex 'set pagination off'"
> -    # disable prompts in case of crash
> +    # Disable prompts in case of crash.
>      gdb_cmd += " -ex 'set confirm off'"
> -    # connect to remote
> +    # Connect automatically to remote only if QEMU is launched.
>      if args.qemu:
>          gdb_cmd += " -ex 'target remote %s'" % (socket_name)
> -    # finally the test script itself
> +    # Finally the test script itself.
>      if args.test:
>          argv = [args.test] + args.test_args
>          gdb_cmd += f" -ex \"py sys.argv={argv}\""

-- 
Alex Bennée
Virtualisation Tech Lead @ Linaro