diff mbox series

[COMMITTED] contrib: Fix 2 bugs in check-params-in-docs.py

Message ID Z1BtsnTq5qfcxLSo@localhost.localdomain
State New
Headers
Series [COMMITTED] contrib: Fix 2 bugs in check-params-in-docs.py |

Checks

Context Check Description
linaro-tcwg-bot/tcwg_gcc_build--master-arm fail Patch failed to apply
linaro-tcwg-bot/tcwg_gcc_build--master-aarch64 fail Patch failed to apply

Commit Message

Filip Kastl Dec. 4, 2024, 2:56 p.m. UTC 
  Hi All,

Commiting this as obvious.

Cheers,
Filip Kastl


-- 8< --


In my last patch for check-params-in-docs.py I accidentally
1. left one occurence of the 'help_params' variable not renamed
2. converted 'help_params' from a dict to a list

These issues cause the script to error when encountering a parameter
missing in docs.  This patch should fix these issues.

contrib/ChangeLog:

	* check-params-in-docs.py: 'params' -> 'help_params'.  Don't
	convert 'help_params' to a list.

Signed-off-by: Filip Kastl <fkastl@suse.cz>
---
 contrib/check-params-in-docs.py | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
diff mbox series

Patch

diff --git a/contrib/check-params-in-docs.py b/contrib/check-params-in-docs.py
index 102f0e64e98..5d5c64c14f7 100755
--- a/contrib/check-params-in-docs.py
+++ b/contrib/check-params-in-docs.py
@@ -57,7 +57,7 @@  for line in open(args.params_output).readlines():
         help_params[r[0]] = r[1]
 
 # Skip target-specific params
-help_params = [x for x in help_params.keys() if not target_specific(x)]
+help_params = {x:y for x,y in help_params.items() if not target_specific(x)}
 
 # Find section in .texi manual with parameters
 texi = ([x.strip() for x in open(args.texi_file).readlines()])
@@ -87,7 +87,7 @@  for line in texi:
 texi_params = [x for x in texi_params if not target_specific(x)]
 
 texi_set = set(texi_params) - ignored
-params_set = set(help_params) - ignored
+params_set = set(help_params.keys()) - ignored
 
 success = True
 extra = texi_set - params_set
@@ -101,7 +101,7 @@  if len(missing):
     print('Missing:')
     for m in missing:
         print('@item ' + m)
-        print(params[m])
+        print(help_params[m])
         print()
     success = False