From: Vishal Verma <vishal.l.verma@intel.com>
To: linux-nvdimm@lists.01.org
Subject: [ndctl PATCH] ndctl: deprecate undocumented short-options
Date: Fri, 27 Jul 2018 12:30:50 -0600 [thread overview]
Message-ID: <20180727183050.13047-1-vishal.l.verma@intel.com> (raw)
The inject-smart and monitor man pages refrained from displaying short
options for various arguments (alarms, daemon) due to a lack of a coherent
letter that could be made to relate to the event name. It was expected
that the user will always use the long option for these. Since the
OPT_STRING helper refused to take an empty string for the short option,
we used bogus characters for each of them.
However there is a better way to provide no short options, and that is
by using '\0' for the short option field to OPT_STRING. Replace the
bogus characters with '\0' so that the 'short help' also becomes
consistent with the man pages.
Cc: Cc: QI Fuli <qi.fuli@jp.fujitsu.com>
Signed-off-by: Vishal Verma <vishal.l.verma@intel.com>
---
ndctl/inject-smart.c | 7 ++++---
ndctl/monitor.c | 2 +-
2 files changed, 5 insertions(+), 4 deletions(-)
diff --git a/ndctl/inject-smart.c b/ndctl/inject-smart.c
index 006ea2a..edb87e1 100644
--- a/ndctl/inject-smart.c
+++ b/ndctl/inject-smart.c
@@ -73,7 +73,7 @@ OPT_STRING('M', "media-temperature-threshold", \
¶m.media_temperature_threshold, \
"set smart media temperature threshold", \
"set threshold value for smart media temperature"), \
-OPT_STRING('x', "media-temperature-alarm", ¶m.media_temperature_alarm, \
+OPT_STRING('\0', "media-temperature-alarm", ¶m.media_temperature_alarm, \
"smart media temperature alarm", \
"enable or disable the smart media temperature alarm"), \
OPT_STRING('c', "ctrl-temperature", ¶m.ctrl_temperature, \
@@ -83,7 +83,7 @@ OPT_STRING('C', "ctrl-temperature-threshold", \
¶m.ctrl_temperature_threshold, \
"set smart controller temperature threshold", \
"set threshold value for smart controller temperature"), \
-OPT_STRING('y', "ctrl-temperature-alarm", ¶m.ctrl_temperature_alarm, \
+OPT_STRING('\0', "ctrl-temperature-alarm", ¶m.ctrl_temperature_alarm, \
"smart controller temperature alarm", \
"enable or disable the smart controller temperature alarm"), \
OPT_STRING('s', "spares", ¶m.spares, \
@@ -92,13 +92,14 @@ OPT_STRING('s', "spares", ¶m.spares, \
OPT_STRING('S', "spares-threshold", ¶m.spares_threshold, \
"set smart spares threshold", \
"set a threshold value for smart spares"), \
-OPT_STRING('z', "spares-alarm", ¶m.spares_alarm, \
+OPT_STRING('\0', "spares-alarm", ¶m.spares_alarm, \
"smart spares alarm", \
"enable or disable the smart spares alarm"), \
OPT_BOOLEAN('f', "fatal", ¶m.fatal, "inject fatal smart health status"), \
OPT_BOOLEAN('U', "unsafe-shutdown", ¶m.unsafe_shutdown, \
"inject smart unsafe shutdown status")
+
static const struct option smart_opts[] = {
SMART_OPTIONS(),
OPT_END(),
diff --git a/ndctl/monitor.c b/ndctl/monitor.c
index b97d1ea..c6419ad 100644
--- a/ndctl/monitor.c
+++ b/ndctl/monitor.c
@@ -583,7 +583,7 @@ int cmd_monitor(int argc, const char **argv, void *ctx)
"where to output the monitor's notification"),
OPT_FILENAME('c', "config-file", &monitor.config_file,
"config-file", "override the default config"),
- OPT_BOOLEAN('x', "daemon", &monitor.daemon,
+ OPT_BOOLEAN('\0', "daemon", &monitor.daemon,
"run ndctl monitor as a daemon"),
OPT_BOOLEAN('u', "human", &monitor.human,
"use human friendly output formats"),
--
2.14.4
_______________________________________________
Linux-nvdimm mailing list
Linux-nvdimm@lists.01.org
https://lists.01.org/mailman/listinfo/linux-nvdimm
next reply other threads:[~2018-07-27 18:30 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-07-27 18:30 Vishal Verma [this message]
2018-07-30 2:27 ` [ndctl PATCH] ndctl: deprecate undocumented short-options Qi, Fuli
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=20180727183050.13047-1-vishal.l.verma@intel.com \
--to=vishal.l.verma@intel.com \
--cc=linux-nvdimm@lists.01.org \
/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;
as well as URLs for NNTP newsgroup(s).