Skip to contentSkip to conversation

cmd_mem.c: Fix simple typoes, no functional changes.

PATCH New Robert P. J. Day 3 participants 6 messages Feb 2, 2013 – Feb 3, 2013

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 cmd_mem.c: Fix simple typoes, no functional changes.

---

based on perusal of entire file as i was reading code. undoubtedly
more of these file-wide proofreads coming if no objections ...

common/cmd_mem.c +4 -4
index 0f3ffc8..2568c04 100644
@@ -462,7 +462,7 @@ static int do_mem_loop(cmd_tbl_t *cmdtp, int flag, int argc,
 	if (argc < 3)
 		return CMD_RET_USAGE;
 
-	/* Check for a size spefication.
+	/* Check for a size specification.
 	 * Defaults to long if no or incorrect specification.
 	 */
 	if ((size = cmd_get_data_size(argv[0], 4)) < 0)
@@ -531,7 +531,7 @@ int do_mem_loopw (cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
 	if (argc < 4)
 		return CMD_RET_USAGE;
 
-	/* Check for a size spefication.
+	/* Check for a size specification.
 	 * Defaults to long if no or incorrect specification.
 	 */
 	if ((size = cmd_get_data_size(argv[0], 4)) < 0)
@@ -683,7 +683,7 @@ static int do_mem_mtest(cmd_tbl_t *cmdtp, int flag, int argc,
 		 * Data line test: write a pattern to the first
 		 * location, write the 1's complement to a 'parking'
 		 * address (changes the state of the data bus so a
-		 * floating bus doen't give a false OK), and then
+		 * floating bus doesn't give a false OK), and then
 		 * read the value back. Note that we read it back
 		 * into a variable because the next time we read it,
 		 * it might be right (been there, tough to explain to
@@ -747,7 +747,7 @@ static int do_mem_mtest(cmd_tbl_t *cmdtp, int flag, int argc,
 		 *              1's test on the relevant bits of the
 		 *              address and checking for aliasing.
 		 *              This test will find single-bit
-		 *              address failures such as stuck -high,
+		 *              address failures such as stuck-high,
 		 *              stuck-low, and shorted pins. The base
 		 *              address and size of the region are
 		 *              selected by the caller.
Signature · 7 lines
========================================================================
Robert P. J. Day                                 Ottawa, Ontario, CANADA
                        http://crashcourse.ca

Twitter:                                       http://twitter.com/rpjday
LinkedIn:                               http://ca.linkedin.com/in/rpjday
========================================================================
#1 lore raw

PATCH 1/1 cmd_mem.c: Fix simple typoes, no functional changes.

Quoted 40 lines · Robert P. J. Day

---

based on perusal of entire file as i was reading code. undoubtedly
more of these file-wide proofreads coming if no objections ...

common/cmd_mem.c +3 -3
index 0f3ffc8..2568c04 100644
@@ -462,7 +462,7 @@ static int do_mem_loop(cmd_tbl_t *cmdtp, int flag, int argc,
  	if (argc < 3)
  		return CMD_RET_USAGE;
 
-	/* Check for a size spefication.
+	/* Check for a size specification.
  	 * Defaults to long if no or incorrect specification.
  	 */
  	if ((size = cmd_get_data_size(argv[0], 4)) < 0)
@@ -531,7 +531,7 @@ int do_mem_loopw (cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
  	if (argc < 4)
  		return CMD_RET_USAGE;
 
-	/* Check for a size spefication.
+	/* Check for a size specification.
  	 * Defaults to long if no or incorrect specification.
  	 */
  	if ((size = cmd_get_data_size(argv[0], 4)) < 0)
@@ -683,7 +683,7 @@ static int do_mem_mtest(cmd_tbl_t *cmdtp, int flag, int argc,
  		 * Data line test: write a pattern to the first
  		 * location, write the 1's complement to a 'parking'
  		 * address (changes the state of the data bus so a
-		 * floating bus doen't give a false OK), and then
+		 * floating bus doesn't give a false OK), and then
  		 * read the value back. Note that we read it back
  		 * into a variable because the next time we read it,
  		 * it might be right (been there, tough to explain to

common/cmd_mem.c static int do_mem_mtest(cmd_tbl_t *cmdtp, int flag, int argc, · line 753

Quoted 8 lines
common/cmd_mem.c +1 -1
@@ -747,7 +747,7 @@ static int do_mem_mtest(cmd_tbl_t *cmdtp, int flag, int argc,
  		 *              1's test on the relevant bits of the
  		 *              address and checking for aliasing.
  		 *              This test will find single-bit
-		 *              address failures such as stuck -high,
+		 *              address failures such as stuck-high,
  		 *              stuck-low, and shorted pins. The base
  		 *              address and size of the region are
  		 *              selected by the caller.

nitpicking: the summary line should not end with a dot.

multi line comments in u-boot are commonly

/*
* I span
* multiple lines
*/

So while at it, you might want to add the empty opening line as well.

Regards,
Jeroen

#2 lore raw

PATCH 1/1 cmd_mem.c: Fix simple typoes, no functional changes.

Quoted 22 lines · Jeroen Hofstee
Quoted 21 lines · Robert P. J. Day

---

based on perusal of entire file as i was reading code. undoubtedly
more of these file-wide proofreads coming if no objections ...

common/cmd_mem.c +1 -1
index 0f3ffc8..2568c04 100644
@@ -462,7 +462,7 @@ static int do_mem_loop(cmd_tbl_t *cmdtp, int flag, int
 argc,
  	if (argc < 3)
  		return CMD_RET_USAGE;
 
-	/* Check for a size spefication.
+	/* Check for a size specification.
  	 * Defaults to long if no or incorrect specification.
  	 */

if ((size = cmd_get_data_size(argv[0], 4)) < 0)

.. snip ...

Quoted 1 line

nitpicking: the summary line should not end with a dot.

point taken, i can resubmit.

Quoted 8 lines

multi line comments in u-boot are commonly

/*
* I span
* multiple lines
*/

So while at it, you might want to add the empty opening line as well.

in cases like this, it's kind of a judgment call. if that's truly a
strict standard, then sure. but i'm pretty sure there's a *lot* of the above type of comment in the source and when i'm just fixing comments, i prefer to make as unobtrusive a change as possible.

i'll let wolfgang decide, and i'll go with whatever he chooses.
note carefully that you used the phrase "commonly", without claiming that it's a hard and fast standard, which is why i left it alone.

rday

Signature · 7 lines
========================================================================
Robert P. J. Day                                 Ottawa, Ontario, CANADA
                        http://crashcourse.ca

Twitter:                                       http://twitter.com/rpjday
LinkedIn:                               http://ca.linkedin.com/in/rpjday
========================================================================
#3 lore raw

PATCH 1/1 cmd_mem.c: Fix simple typoes, no functional changes.

Dear Robert,

Quoted 8 lines · In message <alpine.DEB.2.02.1302030404210.5835@oneiric> you wrote:
Quoted 8 lines

multi line comments in u-boot are commonly

/*
* I span
* multiple lines
*/

Quoted 6 lines
Quoted 1 line

So while at it, you might want to add the empty opening line as well.

in cases like this, it's kind of a judgment call. if that's truly a
strict standard, then sure. but i'm pretty sure there's a *lot* of the above type of comment in the source and when i'm just fixing comments, i prefer to make as unobtrusive a change as possible.

If you are editing these, then please also fix the multi-line comment style as suggested. Thanks.

Best regards,

Wolfgang Denk

Signature · 6 lines
DENX Software Engineering GmbH,     MD: Wolfgang Denk & Detlev Zundel
HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany
Phone: (+49)-8142-66989-10 Fax: (+49)-8142-66989-80 Email: wd at denx.de
God runs electromagnetics by wave theory on  Monday,  Wednesday,  and
Friday,  and the Devil runs them by quantum theory on Tuesday, Thurs-
day, and Saturday.                                   -- William Bragg
#4 lore raw

PATCH 1/1 cmd_mem.c: Fix simple typoes, no functional changes.

Quoted 13 lines · Wolfgang Denk

Dear Robert,

Quoted 10 lines · In message <alpine.DEB.2.02.1302030404210.5835@oneiric> you wrote:
Quoted 9 lines

multi line comments in u-boot are commonly

/*
* I span
* multiple lines
*/

So while at it, you might want to add the empty opening line as well.

Quoted 7 lines
Quoted 4 lines

in cases like this, it's kind of a judgment call. if that's truly a
strict standard, then sure. but i'm pretty sure there's a *lot* of the above type of comment in the source and when i'm just fixing comments, i prefer to make as unobtrusive a change as possible.

If you are editing these, then please also fix the multi-line comment style as suggested. Thanks.

so what is the actual standard? besides the above, line space
above? line space below? because i see all sorts of variations in the code, the most common of which is:

... snip ...
static int mod_mem(cmd_tbl_t *, int, int, int, char * const []);

/* Display values from last command.
* Memory modify remembered values are different from display memory. */
static uint dp_last_addr, dp_last_size;
... snip ...

which, as you can see, has a leading blank line but not a following one. so what's correct? is this written down somewhere?

rday

Signature · 7 lines
========================================================================
Robert P. J. Day                                 Ottawa, Ontario, CANADA
                        http://crashcourse.ca

Twitter:                                       http://twitter.com/rpjday
LinkedIn:                               http://ca.linkedin.com/in/rpjday
========================================================================
#5 lore raw

PATCH 1/1 cmd_mem.c: Fix simple typoes, no functional changes.

Dear Robert,

Quoted 4 lines · In message <alpine.DEB.2.02.1302030522480.6448@oneiric> you wrote:

so what is the actual standard? besides the above, line space
above? line space below? because i see all sorts of variations in the code, the most common of which is:

The "standard" is the Linux CodingStyle:

------------------------- snip ---------------------- The preferred style for long (multi-line) comments is:

/*
* This is the preferred style for multi-line
* comments in the Linux kernel source code.
* Please use it consistently.
*
* Description: A column of asterisks on the left side,
* with beginning and ending almost-blank lines. */

------------------------- snip ----------------------

Regarding the space above and blow, I'm not aware of any "standard". Please apply common sense.

Quoted 2 lines

which, as you can see, has a leading blank line but not a following one. so what's correct? is this written down somewhere?

Not that I'm aware of.

Best regards,

Wolfgang Denk

Signature · 5 lines
DENX Software Engineering GmbH,     MD: Wolfgang Denk & Detlev Zundel
HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany
Phone: (+49)-8142-66989-10 Fax: (+49)-8142-66989-80 Email: wd at denx.de
A year spent in artificial intelligence is enough to make one believe
in God.