Commit 7a372bbe authored by Jim Harris's avatar Jim Harris Committed by Tomasz Zawadzki
Browse files

rpc.py: only use dashes in argument names 



SPDK has been inconsistent in the argument names,
most use dashes (--max-subsystems, --io-unit-size),
but in some cases we had underscores (--tgt_name,
--include_aliases).

So let's do 3 things here:

1) convert all argument names to use dashes only
2) if user passes and argument with an underscore,
   convert it to a dash implicitly - this ensures
   backward compatability and is a bit less pedantic
3) enforce use of dashes in check_format.sh

Signed-off-by: default avatarJim Harris <james.r.harris@intel.com>
Change-Id: I99289d3d3b03ce40cf192ad4fddec7b5c6bc8388
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/9390


Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com>
Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: default avatarPaul Luse <paul.e.luse@intel.com>
Reviewed-by: default avatarJacek Kalwas <jacek.kalwas@intel.com>
Reviewed-by: default avatarBen Walker <benjamin.walker@intel.com>
Reviewed-by: default avatarShuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
parent 0fb77ea8

scripts/check_format.sh

+19 −0
Original line number Diff line number Diff line
@@ -605,6 +605,24 @@ function check_markdown_format() { 
	return $rc

}



function check_rpc_args() {

	local rc=0



	echo -n "Checking rpc.py argument option names..."

	grep add_argument scripts/rpc.py | grep -oP "(?<=--)[a-z0-9\-\_]*(?=\')" | grep "_" > badargs.log



	if [[ -s badargs.log ]]; then

		echo "rpc.py arguments with underscores detected!"

		cat badargs.log

		echo "Please convert the underscores to dashes."

		rc=1

	else

		echo " OK"

	fi

	rm -f badargs.log

	return $rc

}



rc=0



check_permissions || rc=1
@@ -633,5 +651,6 @@ check_bash_style || rc=1 
check_bash_static_analysis || rc=1

check_changelog || rc=1

check_json_rpc || rc=1

check_rpc_args || rc=1



exit $rc

scripts/rpc.py

+51 −38

File changed.

Preview size limit exceeded, changes collapsed.