From: Holger Schurig <holgerschurig@gmail.com>
To: barebox@lists.infradead.org
Subject: [PATCH] oftree, of_dump: fix help texts
Date: Fri, 30 May 2014 12:03:53 +0200 [thread overview]
Message-ID: <1401444233-17881-1-git-send-email-holgerschurig@gmail.com> (raw)
* don't use <FOO> for options
* don't use \n in BAREBOX_CMD_HELP_OPT
* harmonize Kconfig help text with command help text
Signed-off-by: Holger Schurig <holgerschurig@gmail.com>
---
commands/Kconfig | 11 ++++++-----
commands/of_dump.c | 6 +++---
commands/oftree.c | 4 ++--
3 files changed, 11 insertions(+), 10 deletions(-)
diff --git a/commands/Kconfig b/commands/Kconfig
index 6043cb6..bd058ae 100644
--- a/commands/Kconfig
+++ b/commands/Kconfig
@@ -1897,7 +1897,7 @@ config CMD_OF_DUMP
Usage: of_dump [-f] [NODE]
Options:
- -f <dtb> work on <dtb> instead of internal devicetree
+ -f DTB work on DTB instead of internal devicetree
config CMD_OF_NODE
tristate
@@ -1938,12 +1938,13 @@ config CMD_OFTREE
help
oftree - handle device trees
- Usage: oftree [-lpfdn] [DTB]
+ Usage: oftree [-lspf]
Options:
- -l Load DTB to internal device tree
- -p probe devices from stored device tree
- -f free stored device tree
+ -l DTB Load DTB to internal devicetree
+ -s DTB save internal devicetree to DTB
+ -p probe devices from stored device tree
+ -f free stored device tree
config CMD_TIME
bool "time"
diff --git a/commands/of_dump.c b/commands/of_dump.c
index e341942..e85d859 100644
--- a/commands/of_dump.c
+++ b/commands/of_dump.c
@@ -95,13 +95,13 @@ out:
BAREBOX_CMD_HELP_START(of_dump)
BAREBOX_CMD_HELP_TEXT("Options:")
-BAREBOX_CMD_HELP_OPT ("-f dtb", "work on dtb instead of internal devicetree\n")
+BAREBOX_CMD_HELP_OPT ("-f DTB", "work on dtb instead of internal devicetree")
BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(of_dump)
.cmd = do_of_dump,
- BAREBOX_CMD_DESC("dump devicetree nodes")
- BAREBOX_CMD_OPTS("[-f]")
+ BAREBOX_CMD_DESC("Dump device tree or parts of it.")
+ BAREBOX_CMD_OPTS("[-f] [NODE]")
BAREBOX_CMD_GROUP(CMD_GRP_MISC)
BAREBOX_CMD_COMPLETE(devicetree_file_complete)
BAREBOX_CMD_HELP(cmd_of_dump_help)
diff --git a/commands/oftree.c b/commands/oftree.c
index a3b0e04..1ab86f0 100644
--- a/commands/oftree.c
+++ b/commands/oftree.c
@@ -136,8 +136,8 @@ out:
BAREBOX_CMD_HELP_START(oftree)
BAREBOX_CMD_HELP_TEXT("Options:")
-BAREBOX_CMD_HELP_OPT ("-l <DTB>", "Load <DTB> to internal devicetree\n")
-BAREBOX_CMD_HELP_OPT ("-s <DTB>", "save internal devicetree to <DTB>\n")
+BAREBOX_CMD_HELP_OPT ("-l DTB", "Load DTB to internal devicetree")
+BAREBOX_CMD_HELP_OPT ("-s DTB", "save internal devicetree to DTB")
BAREBOX_CMD_HELP_OPT ("-p", "probe devices from stored device tree")
BAREBOX_CMD_HELP_OPT ("-f", "free stored device tree")
BAREBOX_CMD_HELP_END
--
1.7.10.4
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
reply other threads:[~2014-05-30 9:59 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
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=1401444233-17881-1-git-send-email-holgerschurig@gmail.com \
--to=holgerschurig@gmail.com \
--cc=barebox@lists.infradead.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