[PATCH] command: state: harmonize in-barebox documentation

Marc Kleine-Budde mkl at pengutronix.de
Thu Apr 16 06:15:22 PDT 2015


According to this patch by Holger Schurig:

    f1f532084a6e commands: harmonize in-barebox documentation

Signed-off-by: Marc Kleine-Budde <mkl at 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




More information about the barebox mailing list