From: Bartosz Golaszewski <brgl@bgdev.pl>
To: Kent Gibson <warthog618@gmail.com>,
Linus Walleij <linus.walleij@linaro.org>,
Andy Shevchenko <andriy.shevchenko@linux.intel.com>,
Viresh Kumar <viresh.kumar@linaro.org>
Cc: linux-gpio@vger.kernel.org,
Bartosz Golaszewski <bartosz.golaszewski@linaro.org>
Subject: [libgpiod][PATCH] tools: clarify the non-option arguments in help text
Date: Tue, 4 Jul 2023 14:12:22 +0200 [thread overview]
Message-ID: <20230704121222.314617-1-brgl@bgdev.pl> (raw)
From: Bartosz Golaszewski <bartosz.golaszewski@linaro.org>
We already use [] for optional and <> for required arguments in help text
but let's make it clear that we can pass multiple chips/lines and in most
tools only the first one is required.
Signed-off-by: Bartosz Golaszewski <bartosz.golaszewski@linaro.org>
---
tools/gpiodetect.c | 2 +-
tools/gpioget.c | 2 +-
tools/gpioinfo.c | 2 +-
tools/gpiomon.c | 2 +-
tools/gpionotify.c | 2 +-
tools/gpioset.c | 2 +-
6 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/tools/gpiodetect.c b/tools/gpiodetect.c
index 0a3461b..569cdfe 100644
--- a/tools/gpiodetect.c
+++ b/tools/gpiodetect.c
@@ -12,7 +12,7 @@
static void print_help(void)
{
- printf("Usage: %s [OPTIONS] [chip]...\n", get_prog_name());
+ printf("Usage: %s [OPTIONS] [chip1] [chip2] ...\n", get_prog_name());
printf("\n");
printf("List GPIO chips, print their labels and number of GPIO lines.\n");
printf("\n");
diff --git a/tools/gpioget.c b/tools/gpioget.c
index f611737..5d3092b 100644
--- a/tools/gpioget.c
+++ b/tools/gpioget.c
@@ -26,7 +26,7 @@ struct config {
static void print_help(void)
{
- printf("Usage: %s [OPTIONS] <line>...\n", get_prog_name());
+ printf("Usage: %s [OPTIONS] <line1> [line2] ...\n", get_prog_name());
printf("\n");
printf("Read values of GPIO lines.\n");
printf("\n");
diff --git a/tools/gpioinfo.c b/tools/gpioinfo.c
index 44d1c8c..002d631 100644
--- a/tools/gpioinfo.c
+++ b/tools/gpioinfo.c
@@ -20,7 +20,7 @@ struct config {
static void print_help(void)
{
- printf("Usage: %s [OPTIONS] [line]...\n", get_prog_name());
+ printf("Usage: %s [OPTIONS] [line1] [line2] ...\n", get_prog_name());
printf("\n");
printf("Print information about GPIO lines.\n");
printf("\n");
diff --git a/tools/gpiomon.c b/tools/gpiomon.c
index e3abb2d..cb76913 100644
--- a/tools/gpiomon.c
+++ b/tools/gpiomon.c
@@ -35,7 +35,7 @@ struct config {
static void print_help(void)
{
- printf("Usage: %s [OPTIONS] <line>...\n", get_prog_name());
+ printf("Usage: %s [OPTIONS] <line1> [line2] ...\n", get_prog_name());
printf("\n");
printf("Wait for events on GPIO lines and print them to standard output.\n");
printf("\n");
diff --git a/tools/gpionotify.c b/tools/gpionotify.c
index 2c56590..71eacbb 100644
--- a/tools/gpionotify.c
+++ b/tools/gpionotify.c
@@ -28,7 +28,7 @@ struct config {
static void print_help(void)
{
- printf("Usage: %s [OPTIONS] <line>...\n", get_prog_name());
+ printf("Usage: %s [OPTIONS] <line1> [line2] ...\n", get_prog_name());
printf("\n");
printf("Wait for changes to info on GPIO lines and print them to standard output.\n");
printf("\n");
diff --git a/tools/gpioset.c b/tools/gpioset.c
index 9dc5aeb..e0d971c 100644
--- a/tools/gpioset.c
+++ b/tools/gpioset.c
@@ -36,7 +36,7 @@ struct config {
static void print_help(void)
{
- printf("Usage: %s [OPTIONS] <line=value>...\n", get_prog_name());
+ printf("Usage: %s [OPTIONS] <line1=value1> [line2=value2] ...\n", get_prog_name());
printf("\n");
printf("Set values of GPIO lines.\n");
printf("\n");
--
2.39.2
next reply other threads:[~2023-07-04 12:12 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-07-04 12:12 Bartosz Golaszewski [this message]
2023-07-04 12:50 ` [libgpiod][PATCH] tools: clarify the non-option arguments in help text Kent Gibson
2023-07-04 14:45 ` Andy Shevchenko
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=20230704121222.314617-1-brgl@bgdev.pl \
--to=brgl@bgdev.pl \
--cc=andriy.shevchenko@linux.intel.com \
--cc=bartosz.golaszewski@linaro.org \
--cc=linus.walleij@linaro.org \
--cc=linux-gpio@vger.kernel.org \
--cc=viresh.kumar@linaro.org \
--cc=warthog618@gmail.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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox