[v2,5/5] mtdinfo: consolidate help as display_help()
diff mbox

Message ID 1312925806-15929-6-git-send-email-computersforpeace@gmail.com
State New, archived
Headers show

Commit Message

Brian Norris Aug. 9, 2011, 9:36 p.m. UTC
The help message for mtdinfo is unnecessarily disjointed. It is split
into three strings which reuse the PROGRAM_NAME string inefficiently and
don't have a consistent style.

This fixup should provide a cleaner look with aligned columns and
easier-to-read source code.

Signed-off-by: Brian Norris <computersforpeace@gmail.com>
---
 ubi-utils/mtdinfo.c |   36 +++++++++++++++++++-----------------
 1 files changed, 19 insertions(+), 17 deletions(-)

Comments

Mike Frysinger Aug. 11, 2011, 4:33 a.m. UTC | #1
On Tue, Aug 9, 2011 at 17:36, Brian Norris wrote:
> +static void display_help(void)
> +{
> +       printf(
> +"%1$s version %2$s - a tool to print MTD information.\n"

please properly indent
<tab>printf(
<tab><tab>"..........."
-mike

Patch
diff mbox

diff --git a/ubi-utils/mtdinfo.c b/ubi-utils/mtdinfo.c
index 1c3a46f..9f25fd8 100644
--- a/ubi-utils/mtdinfo.c
+++ b/ubi-utils/mtdinfo.c
@@ -50,10 +50,16 @@  static struct args args = {
 	.node = NULL,
 };
 
-static const char doc[] = PROGRAM_NAME " version " VERSION
-			 " - a tool to print MTD information.";
-
-static const char optionsstr[] =
+static void display_help(void)
+{
+	printf(
+"%1$s version %2$s - a tool to print MTD information.\n"
+"\n"
+"Usage: %1$s <MTD node file path> [--map | -M] [--ubi-info | -u]\n"
+"       %1$s --all [--ubi-info | -u]\n"
+"       %1$s [--help | --version]\n"
+"\n"
+"Options:\n"
 "-u, --ubi-info                  print what would UBI layout be if it was put\n"
 "                                on this MTD device\n"
 "-M, --map                       print eraseblock map\n"
@@ -61,17 +67,15 @@  static const char optionsstr[] =
 "                                Note: `--all' may give less info per device\n"
 "                                than, e.g., `mtdinfo /dev/mtdX'\n"
 "-h, --help                      print help message\n"
-"-V, --version                   print program version";
-
-static const char usage[] =
-"Usage: " PROGRAM_NAME " <MTD node file path> [--map | -M] [--ubi-info | -u]\n"
-"       " PROGRAM_NAME " --all [--ubi-info | -u]\n"
-"       " PROGRAM_NAME " [--help | --version]\n"
+"-V, --version                   print program version\n"
 "\n"
-"Example 1: " PROGRAM_NAME " /dev/mtd0       print information MTD device /dev/mtd0\n"
-"Example 2: " PROGRAM_NAME " /dev/mtd0 -u    print information MTD device /dev/mtd0\n"
-"\t\t\t\t   and include UBI layout information\n"
-"Example 3: " PROGRAM_NAME " -a              print information about all MTD devices\n";
+"Examples:\n"
+"  %1$s /dev/mtd0             print information MTD device /dev/mtd0\n"
+"  %1$s /dev/mtd0 -u          print information MTD device /dev/mtd0\n"
+"\t\t\t\tand include UBI layout information\n"
+"  %1$s -a                    print information about all MTD devices\n",
+	PROGRAM_NAME, VERSION);
+}
 
 static const struct option long_options[] = {
 	{ .name = "ubi-info",  .has_arg = 0, .flag = NULL, .val = 'u' },
@@ -105,9 +109,7 @@  static int parse_opt(int argc, char * const argv[])
 			break;
 
 		case 'h':
-			printf("%s\n\n", doc);
-			printf("%s\n\n", usage);
-			printf("%s\n", optionsstr);
+			display_help();
 			exit(EXIT_SUCCESS);
 
 		case 'V':