mail archive of the barebox mailing list
 help / color / mirror / Atom feed
From: Marc Kleine-Budde <mkl@pengutronix.de>
To: barebox@lists.infradead.org
Subject: [PATCH] command: state: harmonize in-barebox documentation
Date: Thu, 16 Apr 2015 15:15:22 +0200	[thread overview]
Message-ID: <1429190122-21490-1-git-send-email-mkl@pengutronix.de> (raw)

According to this patch by Holger Schurig:

    f1f532084a6e commands: harmonize in-barebox documentation

Signed-off-by: Marc Kleine-Budde <mkl@pengutronix.de>
---
 commands/state.c | 16 +++++++++-------
 1 file changed, 9 insertions(+), 7 deletions(-)

diff --git a/commands/state.c b/commands/state.c
index 82c29d00c880..59d1eb850215 100644
--- a/commands/state.c
+++ b/commands/state.c
@@ -62,16 +62,18 @@ static int do_state(int argc, char *argv[])
 	return ret;
 }
 
-static const __maybe_unused char cmd_state_help[] =
-"Usage: state [OPTIONS] [STATENAME]\n"
-"\n"
-"options:\n"
-"-s        save state\n"
-"-l        load state\n";
+BAREBOX_CMD_HELP_START(state)
+BAREBOX_CMD_HELP_TEXT("Usage: state [OPTIONS] [STATENAME]")
+BAREBOX_CMD_HELP_TEXT("")
+BAREBOX_CMD_HELP_TEXT("options:")
+BAREBOX_CMD_HELP_OPT ("-s", "save state")
+BAREBOX_CMD_HELP_OPT ("-l", "load state")
+BAREBOX_CMD_HELP_END
 
 BAREBOX_CMD_START(state)
 	.cmd		= do_state,
-	BAREBOX_CMD_DESC("handle state information")
+	BAREBOX_CMD_DESC("load and save state information")
+	BAREBOX_CMD_OPTS("[-sl] [STATENAME]")
 	BAREBOX_CMD_GROUP(CMD_GRP_MISC)
 	BAREBOX_CMD_HELP(cmd_state_help)
 BAREBOX_CMD_END
-- 
2.1.4


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

             reply	other threads:[~2015-04-16 13:15 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-04-16 13:15 Marc Kleine-Budde [this message]
2015-04-17  5:26 ` Sascha Hauer

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=1429190122-21490-1-git-send-email-mkl@pengutronix.de \
    --to=mkl@pengutronix.de \
    --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