All of lore.kernel.org
 help / color / mirror / Atom feed
From: Luca Ceresoli <luca.ceresoli@bootlin.com>
To: "Konstantin Khlebnikov" <koct9i@gmail.com>,
	"Stephen Boyd" <swboyd@chromium.org>,
	"Sasha Levin" <sashal@kernel.org>,
	"Alexis Lothoré" <alexis.lothore@bootlin.com>,
	"Thomas Petazzoni" <thomas.petazzoni@bootlin.com>,
	linux-kernel@vger.kernel.org,
	"Luca Ceresoli" <luca.ceresoli@bootlin.com>
Subject: [PATCH 2/3] scripts/decode_stacktrace.sh: clarify command line
Date: Mon, 11 Mar 2024 16:24:55 +0100	[thread overview]
Message-ID: <20240311-decode_stacktrace-find_module-improvements-v1-2-8bea42b421aa@bootlin.com> (raw)
In-Reply-To: <20240311-decode_stacktrace-find_module-improvements-v1-0-8bea42b421aa@bootlin.com>

The syntax as expressed by usage() is not entirely correct: "<modules
path>" cannot be passed without "<base path>|auto". Additionally human
reading of this syntax can be subject to misunderstanding due the mixture
of '|' and '[]'.

Improve readability in various ways:
 * rewrite using two lines for the two allowed usages
 * add square brackets around "<vmlinux>" as it is optional when using
   debuginfod-find
 * move "<modules path>" to inside the square brackets of the 2nd
   positional parameter
 * use underscores instead of spaces in <...> strings

Signed-off-by: Luca Ceresoli <luca.ceresoli@bootlin.com>
---
 scripts/decode_stacktrace.sh | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/scripts/decode_stacktrace.sh b/scripts/decode_stacktrace.sh
index 7f3fb5e82707..b56e79060e9f 100755
--- a/scripts/decode_stacktrace.sh
+++ b/scripts/decode_stacktrace.sh
@@ -5,7 +5,8 @@
 
 usage() {
 	echo "Usage:"
-	echo "	$0 -r <release> | <vmlinux> [<base path>|auto] [<modules path>]"
+	echo "	$0 -r <release>"
+	echo "	$0 [<vmlinux> [<base_path>|auto [<modules_path>]]]"
 }
 
 # Try to find a Rust demangler

-- 
2.34.1


  parent reply	other threads:[~2024-03-11 15:25 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-03-11 15:24 [PATCH 0/3] scripts/decode_stacktrace.sh: improve error reporting and usability Luca Ceresoli
2024-03-11 15:24 ` [PATCH 1/3] scripts/decode_stacktrace.sh: remove find_module recursion and improve error reporting Luca Ceresoli
2024-05-08 21:35   ` Stephen Boyd
2024-05-09  8:16     ` Luca Ceresoli
2024-03-11 15:24 ` Luca Ceresoli [this message]
2024-05-08 21:37   ` [PATCH 2/3] scripts/decode_stacktrace.sh: clarify command line Stephen Boyd
2024-03-11 15:24 ` [PATCH 3/3] scripts/decode_stacktrace.sh: add '-h' flag Luca Ceresoli
2024-05-08 21:38   ` Stephen Boyd
2024-04-22  9:42 ` [PATCH 0/3] scripts/decode_stacktrace.sh: improve error reporting and usability Luca Ceresoli

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=20240311-decode_stacktrace-find_module-improvements-v1-2-8bea42b421aa@bootlin.com \
    --to=luca.ceresoli@bootlin.com \
    --cc=alexis.lothore@bootlin.com \
    --cc=koct9i@gmail.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=sashal@kernel.org \
    --cc=swboyd@chromium.org \
    --cc=thomas.petazzoni@bootlin.com \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.