public inbox for u-boot@lists.denx.de
 help / color / mirror / Atom feed
From: David Wagner <david.wagner@free-electrons.com>
To: u-boot@lists.denx.de
Subject: [U-Boot] [PATCH 2/9] mkenvimage: correct and clarify comments and error messages
Date: Wed, 23 Nov 2011 21:28:11 +0100	[thread overview]
Message-ID: <1322080098-3151-3-git-send-email-david.wagner@free-electrons.com> (raw)
In-Reply-To: <1322080098-3151-1-git-send-email-david.wagner@free-electrons.com>

Also, don't split error messages over several lines as per a coding style
exception making them easier to grep.

Signed-off-by: David Wagner <david.wagner@free-electrons.com>
---
 tools/mkenvimage.c |   39 ++++++++++++++-------------------------
 1 files changed, 14 insertions(+), 25 deletions(-)

diff --git a/tools/mkenvimage.c b/tools/mkenvimage.c
index 9c32f4a..da54658 100644
--- a/tools/mkenvimage.c
+++ b/tools/mkenvimage.c
@@ -41,12 +41,9 @@
 
 static void usage(const char *exec_name)
 {
-	fprintf(stderr, "%s [-h] [-r] [-b] [-p <byte>] "
-	       "-s <environment partition size> -o <output> <input file>\n"
+	fprintf(stderr, "%s [-h] [-r] [-b] [-p <byte>] -s <environment partition size> -o <output> <input file>\n"
 	       "\n"
-	       "This tool takes a key=value input file (same as would a "
-	       "`printenv' show) and generates the corresponding environment "
-	       "image, ready to be flashed.\n"
+	       "This tool takes a key=value input file (same as would a `printenv' show) and generates the corresponding environment image, ready to be flashed.\n"
 	       "\n"
 	       "\tThe input file is in format:\n"
 	       "\t\tkey1=value1\n"
@@ -54,8 +51,7 @@ static void usage(const char *exec_name)
 	       "\t\t...\n"
 	       "\t-r : the environment has multiple copies in flash\n"
 	       "\t-b : the target is big endian (default is little endian)\n"
-	       "\t-p <byte> : fill the image with <byte> bytes instead of "
-	       "0xff bytes\n"
+	       "\t-p <byte> : fill the image with <byte> bytes instead of 0xff bytes\n"
 	       "\n"
 	       "If the input file is \"-\", data is read from standard input\n",
 	       exec_name);
@@ -89,8 +85,7 @@ int main(int argc, char **argv)
 		case 'o':
 			bin_filename = strdup(optarg);
 			if (!bin_filename) {
-				fprintf(stderr, "Can't strdup() the output "
-						"filename\n");
+				fprintf(stderr, "Can't strdup() the output filename\n");
 				return EXIT_FAILURE;
 			}
 			break;
@@ -115,22 +110,21 @@ int main(int argc, char **argv)
 
 	/* Check datasize and allocate the data */
 	if (datasize == 0) {
-		fprintf(stderr,
-			"Please specify the size of the envrionnment "
-			"partition.\n");
+		fprintf(stderr, "Please specify the size of the environment partition.\n");
 		usage(argv[0]);
 		return EXIT_FAILURE;
 	}
 
 	dataptr = malloc(datasize * sizeof(*dataptr));
 	if (!dataptr) {
-		fprintf(stderr, "Can't alloc dataptr.\n");
+		fprintf(stderr, "Can't alloc %d bytes for dataptr.\n",
+				datasize);
 		return EXIT_FAILURE;
 	}
 
 	/*
 	 * envptr points to the beginning of the actual environment (after the
-	 * crc and possible `redundant' bit
+	 * crc and possible `redundant' byte
 	 */
 	envsize = datasize - (CRC_SIZE + redundant);
 	envptr = dataptr + CRC_SIZE + redundant;
@@ -166,8 +160,8 @@ int main(int argc, char **argv)
 		/* ... and check it */
 		ret = fstat(txt_fd, &txt_file_stat);
 		if (ret == -1) {
-			fprintf(stderr, "Can't stat() on \"%s\": "
-					"%s\n", txt_filename, strerror(errno));
+			fprintf(stderr, "Can't stat() on \"%s\": %s\n",
+					txt_filename, strerror(errno));
 			return EXIT_FAILURE;
 		}
 
@@ -181,13 +175,9 @@ int main(int argc, char **argv)
 		}
 		ret = close(txt_fd);
 	}
-	/*
-	 * The right test to do is "=>" (not ">") because of the additionnal
-	 * ending \0. See below.
-	 */
-	if (filesize >= envsize) {
-		fprintf(stderr, "The input file is larger than the "
-				"envrionnment partition size\n");
+	/* The +1 is for the additionnal ending \0. See below. */
+	if (filesize + 1 > envsize) {
+		fprintf(stderr, "The input file is larger than the environment partition size\n");
 		return EXIT_FAILURE;
 	}
 
@@ -236,8 +226,7 @@ int main(int argc, char **argv)
 		 * check the env size again to make sure we have room for two \0
 		 */
 		if (ep >= envsize) {
-			fprintf(stderr, "The environment file is too large for "
-					"the target environment storage\n");
+			fprintf(stderr, "The environment file is too large for the target environment storage\n");
 			return EXIT_FAILURE;
 		}
 		envptr[ep] = '\0';
-- 
1.7.7.3

  parent reply	other threads:[~2011-11-23 20:28 UTC|newest]

Thread overview: 47+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-11-23 20:28 [U-Boot] [PATCH 0/9] mkenvimage: v10/v11 diff split into several patches David Wagner
2011-11-23 20:28 ` [U-Boot] [PATCH 1/9] Strip mkenvimage David Wagner
2012-01-13 20:03   ` Wolfgang Denk
2011-11-23 20:28 ` David Wagner [this message]
2011-12-21  0:58   ` [U-Boot] [PATCHv2 02/10] mkenvimage: correct and clarify comments and error messages David Wagner
2011-12-21  7:41     ` Thomas Petazzoni
2011-12-21 22:10       ` David Wagner
2011-11-23 20:28 ` [U-Boot] [PATCH 3/9] mkenvimage: Correct the includes and add a missing one David Wagner
2011-12-21  0:58   ` [U-Boot] [PATCHv2 03/10] " David Wagner
2012-01-05 16:28     ` Wolfgang Denk
2012-01-05 18:44       ` [U-Boot] [PATCHv2 1/8] Strip mkenvimage David Wagner
2012-01-05 18:44         ` [U-Boot] [PATCHv3 2/8] mkenvimage: correct and clarify comments and error messages David Wagner
2012-01-05 18:44         ` [U-Boot] [PATCHv3 3/8] mkenvimage: Correct the includes and add a missing one David Wagner
2012-01-08  6:48           ` Mike Frysinger
2012-01-08 13:08           ` [U-Boot] [PATCHv4 3/8] mkenvimage: Correct an include " David Wagner
2012-01-08 19:09             ` Mike Frysinger
2012-01-05 18:44         ` [U-Boot] [PATCHv2 4/8] mkenvimage: More error handling David Wagner
2012-01-08  6:49           ` Mike Frysinger
2012-01-08 14:25           ` [U-Boot] [PATCHv3 " David Wagner
2012-01-08 19:17             ` Mike Frysinger
2012-01-08 19:50           ` [U-Boot] [PATCHv4 " David Wagner
2012-01-05 18:44         ` [U-Boot] [PATCHv3 5/8] mkenvimage: Read/Write from/to stdin/out by default or if the filename is "-" David Wagner
2012-01-08  6:50           ` Mike Frysinger
2012-01-08 12:02             ` David Wagner
2012-01-08 19:29               ` Mike Frysinger
2012-01-05 18:44         ` [U-Boot] [PATCHv2 6/8] mkenvimage: Use mmap() when reading from a regular file David Wagner
2012-01-08  6:51           ` Mike Frysinger
2012-01-08 13:09           ` [U-Boot] [PATCHv3 " David Wagner
2012-01-05 18:44         ` [U-Boot] [PATCHv2 7/8] mkenvimage: Don't try to detect comments in the input file David Wagner
2012-01-05 18:44         ` [U-Boot] [PATCHv3 8/8] mkenvimage: Really set the redundant byte when applicable David Wagner
2012-01-08  6:46         ` [U-Boot] [PATCHv2 1/8] Strip mkenvimage Mike Frysinger
2011-11-23 20:28 ` [U-Boot] [PATCH 4/9] mkenvimage: More error handling David Wagner
2011-11-23 20:28 ` [U-Boot] [PATCH 5/9] mkenvimage: Read from stdin if the filename is "-" David Wagner
2011-11-27 10:24   ` [U-Boot] [PATCHv2 5/8] mkenvimage: Read/Write from/to stdin/out by default or " David Wagner
2011-11-23 20:28 ` [U-Boot] [PATCH 6/9] mkenvimage: Use mmap() when reading from a regular file David Wagner
2011-11-23 20:28 ` [U-Boot] [PATCH 7/9] mkenvimage: Don't try to detect comments in the input file David Wagner
2011-11-23 20:28 ` [U-Boot] [PATCH 8/9] mkenvimage: Really set the redundant byte when applicable David Wagner
2011-11-25 21:36   ` Mike Frysinger
2011-11-27 10:26   ` [U-Boot] [PATCHv2 8/8] " David Wagner
2011-11-23 20:28 ` [U-Boot] [PATCH 9/9] mkenvimage: Default to stdout if the output argument is absent or "-" David Wagner
2011-11-25 21:36   ` Mike Frysinger
2011-11-27 10:26     ` David Wagner
2011-11-27 19:59 ` [U-Boot] [PATCH 0/9] mkenvimage: v10/v11 diff split into several patches Mike Frysinger
2011-12-21  1:04   ` David Wagner
2011-12-21  8:46     ` Stefano Babic
2012-01-13 20:07 ` Wolfgang Denk
2012-01-13 23:22   ` David Wagner

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=1322080098-3151-3-git-send-email-david.wagner@free-electrons.com \
    --to=david.wagner@free-electrons.com \
    --cc=u-boot@lists.denx.de \
    /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