Skip to contentSkip to conversation

jffs2dump: rewrite --help output to be more suitable for help2man

PATCH In review Timo Lindfors 2 participants 2 messages Jul 27, 2009 – Aug 9, 2009 Memory technology devices (MTD)

lore
Share & tools
lore

Timo Lindfors

author
#0 lore raw

PATCH 1/1 jffs2dump: rewrite --help output to be more suitable for help2man

From: Timo Juhani Lindfors <[email protected]>

$ help2man /usr/sbin/jffs2dump | man /dev/stdin

currently creates badly formatted output like

-b          --bigendian                 image is big endian
-l          --littleendian              image   is   little

endian -c --content dump image
contents -e fname --endianconvert=fname convert
image endianness, output to file fname -r --recalc-

This patch modifies the --help output for jffs2dump to be more suitable for help2man and thus makes it possible to easily create manual pages that stay up-to-date.

Signed-off-by Timo Juhani Lindfors <[email protected]>
---
 jffs2dump.c |   25 ++++++++++++-------------
 1 files changed, 12 insertions(+), 13 deletions(-)
jffs2dump.c +12 -13
index c5a99df..2802682 100644
@@ -52,19 +52,18 @@ char	*data;		// image data
 
 void display_help (void)
 {
-	printf("Usage: dumpjffs2 [OPTION] INPUTFILE\n"
-			"Dumps the contents of a binary JFFS2 image.\n"
-			"\n"
-			"           --help     	              display this help and exit\n"
-			"           --version  	              output version information and exit\n"
-			"-b         --bigendian	              image is big endian\n"
-			"-l         --littleendian             image is little endian\n"
-			"-c         --content  	              dump image contents\n"
-			"-e fname   --endianconvert=fname      convert image endianness, output to file fname\n"
-			"-r         --recalccrc                recalc name and data crc on endian conversion\n"
-			"-d len     --datsize=len              size of data chunks, when oob data in binary image (NAND only)\n"
-			"-o len     --oobsize=len              size of oob data chunk in binary image (NAND only)\n"
-			"-v         --verbose		      verbose output\n");
+	printf("Usage: " PROGRAM " [OPTION]... INPUTFILE\n"
+	       "Dump the contents of a binary JFFS2 image.\n\n"
+	       "     --help                   display this help and exit\n"
+	       "     --version                display version information and exit\n"
+	       " -b, --bigendian              image is big endian\n"
+	       " -l, --littleendian           image is little endian\n"
+	       " -c, --content                dump image contents\n"
+	       " -e, --endianconvert=FNAME    convert image endianness, output to file fname\n"
+	       " -r, --recalccrc              recalc name and data crc on endian conversion\n"
+	       " -d, --datsize=LEN            size of data chunks, when oob data in binary image (NAND only)\n"
+	       " -o, --oobsize=LEN            size of oob data chunk in binary image (NAND only)\n"
+	       " -v, --verbose                verbose output\n");
 	exit(0);
 }

---

If this patch looks ok, I'd be willing to write similar patches for at least nandread, flash_erase and flash_eraseall tools that I use regularly myself.

best regards,
Timo Lindfors

#1 lore raw
Quoted 12 lines · Timo Lindfors

From: Timo Juhani Lindfors<[email protected]>

$ help2man /usr/sbin/jffs2dump | man /dev/stdin

currently creates badly formatted output like

(quoted diff) +0 -2
-b          --bigendian                 image is big endian
-l          --littleendian              image   is   little

endian -c --content dump image
contents -e fname --endianconvert=fname convert
image endianness, output to file fname -r --recalc-

Quoted 5 lines

This patch modifies the --help output for jffs2dump to be more suitable for help2man and thus makes it possible to easily create manual pages that stay up-to-date.

Signed-off-by Timo Juhani Lindfors<[email protected]>

Looks good to me. Pushed to the mtd-utils git tree, thanks.

Signature · 2 lines
Best Regards,
Artem Bityutskiy (Артём Битюцкий)