DPDK patches and discussions
 help / color / mirror / Atom feed
From: Robin Jarry <rjarry@redhat.com>
To: dev@dpdk.org
Cc: Bruce Richardson <bruce.richardson@intel.com>
Subject: [PATCH] cmdline-gen: fix error when command list has empty lines
Date: Thu, 16 Nov 2023 12:18:13 +0100	[thread overview]
Message-ID: <20231116111812.296090-2-rjarry@redhat.com> (raw)

Fix the following error when a command list file contains empty lines:

Traceback (most recent call last):
  File "buildtools/dpdk-cmdline-gen.py", line 202, in <module>
    main()
  File "buildtools/dpdk-cmdline-gen.py", line 184, in main
    process_commands(args.infile, sys.stdout, None, args.context_name)
  File "buildtools/dpdk-cmdline-gen.py", line 141, in process_commands
    cmd_inst, h_out, c_out = process_command(lineno, tokens.strip().spl…
                             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^…
  File "buildtools/dpdk-cmdline-gen.py", line 36, in process_command
    if tokens[0].startswith("<"):
       ~~~~~~^^^
IndexError: list index out of range

Use shlex.split() to properly split each line arguments into tokens and
strip comments.

If there are no tokens, ignore the line.

Fixes: 37666691e9ed ("buildtools: add a tool to generate cmdline boilerplate")

Cc: Bruce Richardson <bruce.richardson@intel.com>
Signed-off-by: Robin Jarry <rjarry@redhat.com>
---
 buildtools/dpdk-cmdline-gen.py | 13 ++++++++-----
 1 file changed, 8 insertions(+), 5 deletions(-)

diff --git a/buildtools/dpdk-cmdline-gen.py b/buildtools/dpdk-cmdline-gen.py
index 8922bb5fc38e..49b03bee4a26 100755
--- a/buildtools/dpdk-cmdline-gen.py
+++ b/buildtools/dpdk-cmdline-gen.py
@@ -7,6 +7,7 @@
 """
 
 import argparse
+import shlex
 import sys
 
 PARSE_FN_PARAMS = "void *parsed_result, struct cmdline *cl, void *data"
@@ -133,12 +134,14 @@ def process_commands(infile, hfile, cfile, ctxname):
     )
 
     for lineno, line in enumerate(infile.readlines()):
-        if line.lstrip().startswith("#"):
+        tokens = shlex.split(line, comments=True)
+        if not tokens:
             continue
-        if "#" not in line:
-            line = line + "#"  # ensure split always works, even if no help text
-        tokens, comment = line.split("#", 1)
-        cmd_inst, h_out, c_out = process_command(lineno, tokens.strip().split(), comment.strip())
+        if "#" in line:
+            comment = line.split("#", 1)[-1].strip()
+        else:
+            comment = ""
+        cmd_inst, h_out, c_out = process_command(lineno, tokens, comment)
         hfile.write("\n".join(h_out))
         if cfile:
             cfile.write("\n".join(c_out))
-- 
2.41.0


             reply	other threads:[~2023-11-16 11:18 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-11-16 11:18 Robin Jarry [this message]
2023-11-17 11:22 ` Bruce Richardson
2023-11-20 12:47   ` Thomas Monjalon

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20231116111812.296090-2-rjarry@redhat.com \
    --to=rjarry@redhat.com \
    --cc=bruce.richardson@intel.com \
    --cc=dev@dpdk.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).