tools: rcu: Add usage function and check for argument
authorBhaskar Chowdhury <unixbhaskar@gmail.com>
Tue, 10 Jan 2023 11:16:34 +0000 (16:46 +0530)
committerBoqun Feng <boqun.feng@gmail.com>
Sun, 12 Mar 2023 02:10:17 +0000 (18:10 -0800)
This commit converts extract-stall.sh script's header comment to a
usage() function, and adds an argument check.  While in the area, make
this script be executable.

[ paulmck: Strength argument check, remove extraneous comment. ]

Signed-off-by: Bhaskar Chowdhury <unixbhaskar@gmail.com>
Signed-off-by: Paul E. McKenney <paulmck@kernel.org>
Signed-off-by: Boqun Feng <boqun.feng@gmail.com>
tools/rcu/extract-stall.sh [changed mode: 0644->0755]

old mode 100644 (file)
new mode 100755 (executable)
index e565697..08a39ad
@@ -1,11 +1,25 @@
 #!/bin/sh
 # SPDX-License-Identifier: GPL-2.0+
-#
-# Extract any RCU CPU stall warnings present in specified file.
-# Filter out clocksource lines.  Note that preceding-lines excludes the
-# initial line of the stall warning but trailing-lines includes it.
-#
-# Usage: extract-stall.sh dmesg-file [ preceding-lines [ trailing-lines ] ]
+
+usage() {
+       echo Extract any RCU CPU stall warnings present in specified file.
+       echo Filter out clocksource lines.  Note that preceding-lines excludes the
+       echo initial line of the stall warning but trailing-lines includes it.
+       echo
+       echo Usage: $(basename $0) dmesg-file [ preceding-lines [ trailing-lines ] ]
+       echo
+       echo Error: $1
+}
+
+# Terminate the script, if the argument is missing
+
+if test -f "$1" && test -r "$1"
+then
+       :
+else
+       usage "Console log file \"$1\" missing or unreadable."
+       exit 1
+fi
 
 echo $1
 preceding_lines="${2-3}"