Re: [dpdk-dev] [PATCH v5 3/3] devtools: check flow API doc tables

On 4/7/2021 11:33 PM, Thomas Monjalon wrote:

The script check-doc-vs-code.sh may be used to add
some automatic checks of the doc.

If run without any argument, a complete check is done.
The optional argument is a git history reference point
to check faster only what has changed since this commit.

In this commit, the only check is for rte_flow tables,
achieved through the script parse-flow-support.sh.
If run without a .ini reference, it prints rte_flow tables.
Note: detected features are marked with the value Y,
while the real .ini file could have special values like I.
The script allow parsing exceptions (exclude or include),
like for bnxt code which lists unsupported items and actions.

Overall great to be able to generate and check document against code, also good
to have this by relatively small/simple scripts, thanks for the work.
This helps to remove the maintenance concerns I had.

Signed-off-by: Thomas Monjalon <redacted>
---
 devtools/check-doc-vs-code.sh  | 79 ++++++++++++++++++++++++++++++++++
 devtools/parse-flow-support.sh | 76 ++++++++++++++++++++++++++++++++

Will there be automated checks as part of the build system? Presumably in
'developer_mode'?


btw, scripts points out some new features not documented in .ini files, those
are the recently added ones, patch requires a rebase on top of latest code.

+rte_flow_support() # <category>
+{
+	title="rte_flow $1s"
+	pattern=$(echo "RTE_FLOW_$1_TYPE_" | awk '{print toupper($0)}')
+	list "$title" "$pattern" | grep -vwE 'void|end'

Should 'RTE_FLOW_ITEM_TYPE_ANY' also excluded, does it have benefit to have it
as listed?