From d462c9edbb81f8abb1b72eec495da806108df090 Mon Sep 17 00:00:00 2001 From: Robert Schwebel Date: Mon, 1 Nov 2010 17:59:12 +0100 Subject: doc: unify documentation for 'saveenv' Signed-off-by: Robert Schwebel --- commands/saveenv.c | 31 ++++++++++++++----------------- 1 file changed, 14 insertions(+), 17 deletions(-) (limited to 'commands/saveenv.c') diff --git a/commands/saveenv.c b/commands/saveenv.c index 42ea58f4da..2f969fe7b9 100644 --- a/commands/saveenv.c +++ b/commands/saveenv.c @@ -94,12 +94,10 @@ out: return ret; } -static const __maybe_unused char cmd_saveenv_help[] = -"Usage: saveenv [] []\n" -"Save the files in to the persistent storage device .\n" -" is normally a block in flash, but could be any other file.\n" -"If ommitted defaults to /env and defaults to /dev/env0.\n" -"Note that envfs can only handle files. Directories are skipped silently.\n"; +BAREBOX_CMD_HELP_START(saveenv) +BAREBOX_CMD_HELP_USAGE("saveenv [envfs] [directory]\n") +BAREBOX_CMD_HELP_SHORT("Save the files in to the persistent storage device .\n") +BAREBOX_CMD_HELP_END BAREBOX_CMD_START(saveenv) .cmd = do_saveenv, @@ -108,15 +106,14 @@ BAREBOX_CMD_START(saveenv) BAREBOX_CMD_END /** - * @page saveenv_command saveenv - * - * Usage: saveenv [\] [\] - * - * Save the files in \ to the persistent storage device \. - * \ is normally a block in flash, but could be any other file. - * - * If ommitted \ defaults to \c /env and \ defaults to - * \c /dev/env0. - * - * @note envfs can only handle files. Directories are skipped silently. + * @page saveenv_command + +

\ is usually a block in flash but can be any other file. If +ommitted, \ defaults to /env and \ defaults to +/dev/env0. Note that envfs can only handle files, directories are being +skipped silently.

+ +\todo What does 'block in flash' mean? Add example. + */ + -- cgit v1.2.3