* [U-Boot] [PATCH] Fix spelling of "occurred".
@ 2016-05-01 2:18 Vagrant Cascadian
2016-05-01 18:55 ` Simon Glass
2016-05-02 23:32 ` [U-Boot] " Tom Rini
0 siblings, 2 replies; 8+ messages in thread
From: Vagrant Cascadian @ 2016-05-01 2:18 UTC (permalink / raw)
To: u-boot
Signed-off-by: Vagrant Cascadian <vagrant@debian.org>
---
board/bf533-ezkit/flash.c | 2 +-
board/mpl/pip405/pip405.c | 2 +-
board/tqc/tqm5200/cmd_stk52xx.c | 2 +-
cmd/fdc.c | 8 ++++----
common/kgdb.c | 2 +-
common/usb_hub.c | 2 +-
drivers/ddr/marvell/a38x/ddr3_init.h | 2 +-
drivers/ddr/marvell/axp/ddr3_hw_training.h | 2 +-
drivers/i2c/kona_i2c.c | 2 +-
drivers/mtd/nand/omap_gpmc.c | 4 ++--
drivers/net/4xx_enet.c | 4 ++--
drivers/net/enc28j60.c | 2 +-
drivers/net/ne2000_base.c | 4 ++--
drivers/usb/gadget/mpc8xx_udc.c | 2 +-
drivers/usb/musb/musb_hcd.c | 6 +++---
include/linux/fb.h | 4 ++--
include/test/ut.h | 12 ++++++------
include/usbdevice.h | 2 +-
18 files changed, 32 insertions(+), 32 deletions(-)
diff --git a/board/bf533-ezkit/flash.c b/board/bf533-ezkit/flash.c
index 3180a76..a7b3519 100644
--- a/board/bf533-ezkit/flash.c
+++ b/board/bf533-ezkit/flash.c
@@ -320,7 +320,7 @@ int poll_toggle_bit(long lOffset)
}
timeout--;
}
- printf("Time out occured \n");
+ printf("Time out occurred \n");
if (timeout < 0)
return FLASH_FAIL;
}
diff --git a/board/mpl/pip405/pip405.c b/board/mpl/pip405/pip405.c
index 7c7690f..1bd2fbf 100644
--- a/board/mpl/pip405/pip405.c
+++ b/board/mpl/pip405/pip405.c
@@ -777,7 +777,7 @@ void print_pip405_info (void)
((sysman & 0x10) == 0x10) ? "" : "not ");
printf ("INIT asserts %sINT1# (NMI)\n",
((sysman & 0x20) == 0x20) ? "" : "not ");
- printf ("INIT occured %d\n", (sysman >> 6) & 0x1);
+ printf ("INIT occurred %d\n", (sysman >> 6) & 0x1);
printf ("SER1 is routed to %s\n",
((flashcom & 0x1) == 0x1) ? "RS485" : "RS232");
printf ("COM2 is routed to %s\n",
diff --git a/board/tqc/tqm5200/cmd_stk52xx.c b/board/tqc/tqm5200/cmd_stk52xx.c
index 9d2d5a8..dc22ee4 100644
--- a/board/tqc/tqm5200/cmd_stk52xx.c
+++ b/board/tqc/tqm5200/cmd_stk52xx.c
@@ -72,7 +72,7 @@ static int spi_transmit(unsigned char data)
spi->dr = data;
/* wait for SPI transmission completed */
while (!(spi->sr & 0x80)) {
- if (spi->sr & 0x40) { /* if write collision occured */
+ if (spi->sr & 0x40) { /* if write collision occurred */
int dummy;
/* do dummy read to clear status register */
diff --git a/cmd/fdc.c b/cmd/fdc.c
index 058ae89..d2281ab 100644
--- a/cmd/fdc.c
+++ b/cmd/fdc.c
@@ -189,7 +189,7 @@ int wait_for_fdc_int(void)
while((read_fdc_reg(FDC_SRA)&0x80)==0) {
timeout--;
udelay(10);
- if(timeout==0) /* timeout occured */
+ if(timeout==0) /* timeout occurred */
return false;
}
return true;
@@ -205,7 +205,7 @@ int read_fdc_byte(void)
/* direction out and ready */
udelay(10);
timeout--;
- if(timeout==0) /* timeout occured */
+ if(timeout==0) /* timeout occurred */
return -1;
}
return read_fdc_reg(FDC_FIFO);
@@ -235,7 +235,7 @@ int write_fdc_byte(unsigned char val)
timeout--;
udelay(10);
fdc_need_more_output();
- if(timeout==0) /* timeout occured */
+ if(timeout==0) /* timeout occurred */
return false;
}
write_fdc_reg(FDC_FIFO,val);
@@ -395,7 +395,7 @@ int fdc_terminate(FDC_COMMAND_STRUCT *pCMD)
int i;
for(i=0;i<100;i++)
udelay(500); /* wait 500usec for fifo overrun */
- while((read_fdc_reg(FDC_SRA)&0x80)==0x00); /* wait as long as no int has occured */
+ while((read_fdc_reg(FDC_SRA)&0x80)==0x00); /* wait as long as no int has occurred */
for(i=0;i<7;i++) {
pCMD->result[i]=(unsigned char)read_fdc_byte();
}
diff --git a/common/kgdb.c b/common/kgdb.c
index d357463..daf53be 100644
--- a/common/kgdb.c
+++ b/common/kgdb.c
@@ -326,7 +326,7 @@ handle_exception (struct pt_regs *regs)
return (0);
}
- /* probably should check which exception occured as well */
+ /* probably should check which exception occurred as well */
if (longjmp_on_fault) {
longjmp_on_fault = 0;
kgdb_longjmp(error_jmp_buf, KGDBERR_MEMFAULT);
diff --git a/common/usb_hub.c b/common/usb_hub.c
index e6a2cdb..4f59802 100644
--- a/common/usb_hub.c
+++ b/common/usb_hub.c
@@ -475,7 +475,7 @@ static int usb_scan_port(struct usb_device_scan *usb_scan)
return 0;
/* Otherwise the device will get removed */
- printf("Port %d over-current occured %d times\n", i + 1,
+ printf("Port %d over-current occurred %d times\n", i + 1,
hub->overcurrent_count[i]);
}
diff --git a/drivers/ddr/marvell/a38x/ddr3_init.h b/drivers/ddr/marvell/a38x/ddr3_init.h
index cb3fb24..8cb0886 100644
--- a/drivers/ddr/marvell/a38x/ddr3_init.h
+++ b/drivers/ddr/marvell/a38x/ddr3_init.h
@@ -120,7 +120,7 @@
#define MV_NO_RESOURCE (0x13) /* Resource not available (memory ...) */
#define MV_FULL (0x14) /* Item is full (Queue or table etc...) */
#define MV_EMPTY (0x15) /* Item is empty (Queue or table etc...) */
-#define MV_INIT_ERROR (0x16) /* Error occured while INIT process */
+#define MV_INIT_ERROR (0x16) /* Error occurred while INIT process */
#define MV_HW_ERROR (0x17) /* Hardware error */
#define MV_TX_ERROR (0x18) /* Transmit operation not succeeded */
#define MV_RX_ERROR (0x19) /* Recieve operation not succeeded */
diff --git a/drivers/ddr/marvell/axp/ddr3_hw_training.h b/drivers/ddr/marvell/axp/ddr3_hw_training.h
index cffa7c4..343a6b6 100644
--- a/drivers/ddr/marvell/axp/ddr3_hw_training.h
+++ b/drivers/ddr/marvell/axp/ddr3_hw_training.h
@@ -41,7 +41,7 @@
#define MV_NO_RESOURCE (0x13) /* Resource not available (memory ...) */
#define MV_FULL (0x14) /* Item is full (Queue or table etc...) */
#define MV_EMPTY (0x15) /* Item is empty (Queue or table etc...) */
-#define MV_INIT_ERROR (0x16) /* Error occured while INIT process */
+#define MV_INIT_ERROR (0x16) /* Error occurred while INIT process */
#define MV_HW_ERROR (0x17) /* Hardware error */
#define MV_TX_ERROR (0x18) /* Transmit operation not succeeded */
#define MV_RX_ERROR (0x19) /* Recieve operation not succeeded */
diff --git a/drivers/i2c/kona_i2c.c b/drivers/i2c/kona_i2c.c
index 9af496b..11f29d9 100644
--- a/drivers/i2c/kona_i2c.c
+++ b/drivers/i2c/kona_i2c.c
@@ -381,7 +381,7 @@ static int bcm_kona_i2c_write_fifo_single(struct bcm_kona_i2c_dev *dev,
return -EREMOTEIO;
}
- /* Check if a timeout occured */
+ /* Check if a timeout occurred */
if (!time_left) {
printf("completion timed out\n");
return -EREMOTEIO;
diff --git a/drivers/mtd/nand/omap_gpmc.c b/drivers/mtd/nand/omap_gpmc.c
index 4814fa2..6a45d28 100644
--- a/drivers/mtd/nand/omap_gpmc.c
+++ b/drivers/mtd/nand/omap_gpmc.c
@@ -106,7 +106,7 @@ static uint32_t gen_true_ecc(uint8_t *ecc_buf)
/*
* omap_correct_data - Compares the ecc read from nand spare area with ECC
- * registers values and corrects one bit error if it has occured
+ * registers values and corrects one bit error if it has occurred
* Further details can be had from OMAP TRM and the following selected links:
* http://en.wikipedia.org/wiki/Hamming_code
* http://www.cs.utexas.edu/users/plaxton/c/337/05f/slides/ErrorCorrection-4.pdf
@@ -479,7 +479,7 @@ static void omap_reverse_list(u8 *list, unsigned int length)
/*
* omap_correct_data_bch - Compares the ecc read from nand spare area
- * with ECC registers values and corrects one bit error if it has occured
+ * with ECC registers values and corrects one bit error if it has occurred
*
* @mtd: MTD device structure
* @dat: page data
diff --git a/drivers/net/4xx_enet.c b/drivers/net/4xx_enet.c
index 3c30f42..bc52ed3 100644
--- a/drivers/net/4xx_enet.c
+++ b/drivers/net/4xx_enet.c
@@ -1726,7 +1726,7 @@ static void mal_err (struct eth_device *dev, unsigned long isr,
mtdcr (MAL0_RXDEIR, 0x80000000);
#ifdef INFO_4XX_ENET
- printf("\nMAL error occured.... ISR = %lx UIC = = %lx MAL_DEF = %lx MAL_ERR= %lx\n",
+ printf("\nMAL error occurred.... ISR = %lx UIC = = %lx MAL_DEF = %lx MAL_ERR= %lx\n",
isr, uic, maldef, mal_errr);
#endif
@@ -1740,7 +1740,7 @@ static void emac_err (struct eth_device *dev, unsigned long isr)
{
EMAC_4XX_HW_PST hw_p = dev->priv;
- printf ("EMAC%d error occured.... ISR = %lx\n", hw_p->devnum, isr);
+ printf ("EMAC%d error occurred.... ISR = %lx\n", hw_p->devnum, isr);
out_be32((void *)EMAC0_ISR + hw_p->hw_addr, isr);
}
diff --git a/drivers/net/enc28j60.c b/drivers/net/enc28j60.c
index 59ea11c..611eabb 100644
--- a/drivers/net/enc28j60.c
+++ b/drivers/net/enc28j60.c
@@ -381,7 +381,7 @@ static int enc_phy_link_wait(enc_dev_t *enc)
udelay(1000);
}
- /* timeout occured */
+ /* timeout occurred */
printf("%s: link down\n", enc->dev->name);
return 1;
}
diff --git a/drivers/net/ne2000_base.c b/drivers/net/ne2000_base.c
index 71d133c..67bf140 100644
--- a/drivers/net/ne2000_base.c
+++ b/drivers/net/ne2000_base.c
@@ -582,7 +582,7 @@ dp83902a_Overflow(void)
/*
* Read in as many packets as we can and acknowledge any and receive
* interrupts. Since the buffer has overflowed, a receive event of
- * some kind will have occured.
+ * some kind will have occurred.
*/
dp83902a_RxEvent();
DP_OUT(base, DP_ISR, DP_ISR_RxP|DP_ISR_RxE);
@@ -592,7 +592,7 @@ dp83902a_Overflow(void)
DP_OUT(base, DP_TCR, DP_TCR_NORMAL);
/*
- * If a transmit command was issued, but no transmit event has occured,
+ * If a transmit command was issued, but no transmit event has occurred,
* restart it here.
*/
DP_IN(base, DP_ISR, isr);
diff --git a/drivers/usb/gadget/mpc8xx_udc.c b/drivers/usb/gadget/mpc8xx_udc.c
index b3e178a..ad5ea7a 100644
--- a/drivers/usb/gadget/mpc8xx_udc.c
+++ b/drivers/usb/gadget/mpc8xx_udc.c
@@ -170,7 +170,7 @@ int udc_init (void)
/* udc_irq
*
- * Poll for whatever events may have occured
+ * Poll for whatever events may have occurred
*/
void udc_irq (void)
{
diff --git a/drivers/usb/musb/musb_hcd.c b/drivers/usb/musb/musb_hcd.c
index 9a3b61a..4947936 100644
--- a/drivers/usb/musb/musb_hcd.c
+++ b/drivers/usb/musb/musb_hcd.c
@@ -73,9 +73,9 @@ static void write_toggle(struct usb_device *dev, u8 ep, u8 dir_out)
}
/*
- * This function checks if RxStall has occured on the endpoint. If a RxStall
- * has occured, the RxStall is cleared and 1 is returned. If RxStall has
- * not occured, 0 is returned.
+ * This function checks if RxStall has occurred on the endpoint. If a RxStall
+ * has occurred, the RxStall is cleared and 1 is returned. If RxStall has
+ * not occurred, 0 is returned.
*/
static u8 check_stall(u8 ep, u8 dir_out)
{
diff --git a/include/linux/fb.h b/include/linux/fb.h
index 652cf3b..fcf331b 100644
--- a/include/linux/fb.h
+++ b/include/linux/fb.h
@@ -388,14 +388,14 @@ struct fb_cursor_user {
#define FB_EVENT_GET_CONSOLE_MAP 0x07
/* CONSOLE-SPECIFIC: set console to framebuffer mapping */
#define FB_EVENT_SET_CONSOLE_MAP 0x08
-/* A hardware display blank change occured */
+/* A hardware display blank change occurred */
#define FB_EVENT_BLANK 0x09
/* Private modelist is to be replaced */
#define FB_EVENT_NEW_MODELIST 0x0A
/* The resolution of the passed in fb_info about to change and
all vc's should be changed */
#define FB_EVENT_MODE_CHANGE_ALL 0x0B
-/* A software display blank change occured */
+/* A software display blank change occurred */
#define FB_EVENT_CONBLANK 0x0C
/* Get drawing requirements */
#define FB_EVENT_GET_REQ 0x0D
diff --git a/include/test/ut.h b/include/test/ut.h
index da7c1a9..85434d7 100644
--- a/include/test/ut.h
+++ b/include/test/ut.h
@@ -17,9 +17,9 @@ struct unit_test_state;
* ut_fail() - Record failure of a unit test
*
* @uts: Test state
- * @fname: Filename where the error occured
- * @line: Line number where the error occured
- * @func: Function name where the error occured
+ * @fname: Filename where the error occurred
+ * @line: Line number where the error occurred
+ * @func: Function name where the error occurred
* @cond: The condition that failed
*/
void ut_fail(struct unit_test_state *uts, const char *fname, int line,
@@ -29,9 +29,9 @@ void ut_fail(struct unit_test_state *uts, const char *fname, int line,
* ut_failf() - Record failure of a unit test
*
* @uts: Test state
- * @fname: Filename where the error occured
- * @line: Line number where the error occured
- * @func: Function name where the error occured
+ * @fname: Filename where the error occurred
+ * @line: Line number where the error occurred
+ * @func: Function name where the error occurred
* @cond: The condition that failed
* @fmt: printf() format string for the error, followed by args
*/
diff --git a/include/usbdevice.h b/include/usbdevice.h
index da5af6e..f27e17f 100644
--- a/include/usbdevice.h
+++ b/include/usbdevice.h
@@ -438,7 +438,7 @@ typedef enum usb_device_event {
DEVICE_HUB_RESET, /* bi - bus has been unplugged */
DEVICE_DESTROY, /* bi - device instance should be destroyed */
- DEVICE_HOTPLUG, /* bi - a hotplug event has occured */
+ DEVICE_HOTPLUG, /* bi - a hotplug event has occurred */
DEVICE_FUNCTION_PRIVATE, /* function - private */
--
2.1.4
^ permalink raw reply related [flat|nested] 8+ messages in thread* [U-Boot] [PATCH] Fix spelling of "occurred".
2016-05-01 2:18 [U-Boot] [PATCH] Fix spelling of "occurred" Vagrant Cascadian
@ 2016-05-01 18:55 ` Simon Glass
2016-05-01 23:34 ` Scott Wood
2016-05-02 23:32 ` [U-Boot] " Tom Rini
1 sibling, 1 reply; 8+ messages in thread
From: Simon Glass @ 2016-05-01 18:55 UTC (permalink / raw)
To: u-boot
Hi,
On 30 April 2016 at 20:18, Vagrant Cascadian <vagrant@debian.org> wrote:
Please can you add a commit message?
> Signed-off-by: Vagrant Cascadian <vagrant@debian.org>
> ---
>
> board/bf533-ezkit/flash.c | 2 +-
> board/mpl/pip405/pip405.c | 2 +-
> board/tqc/tqm5200/cmd_stk52xx.c | 2 +-
> cmd/fdc.c | 8 ++++----
> common/kgdb.c | 2 +-
> common/usb_hub.c | 2 +-
> drivers/ddr/marvell/a38x/ddr3_init.h | 2 +-
> drivers/ddr/marvell/axp/ddr3_hw_training.h | 2 +-
> drivers/i2c/kona_i2c.c | 2 +-
> drivers/mtd/nand/omap_gpmc.c | 4 ++--
> drivers/net/4xx_enet.c | 4 ++--
> drivers/net/enc28j60.c | 2 +-
> drivers/net/ne2000_base.c | 4 ++--
> drivers/usb/gadget/mpc8xx_udc.c | 2 +-
> drivers/usb/musb/musb_hcd.c | 6 +++---
> include/linux/fb.h | 4 ++--
> include/test/ut.h | 12 ++++++------
> include/usbdevice.h | 2 +-
> 18 files changed, 32 insertions(+), 32 deletions(-)
>
Reviewed-by: Simon Glass <sjg@chromium.org>
nit below.
> diff --git a/board/bf533-ezkit/flash.c b/board/bf533-ezkit/flash.c
> index 3180a76..a7b3519 100644
> --- a/board/bf533-ezkit/flash.c
> +++ b/board/bf533-ezkit/flash.c
> @@ -320,7 +320,7 @@ int poll_toggle_bit(long lOffset)
> }
> timeout--;
> }
> - printf("Time out occured \n");
> + printf("Time out occurred \n");
Can you drop the space before \n ?
> if (timeout < 0)
> return FLASH_FAIL;
> }
Regards,
Simon
^ permalink raw reply [flat|nested] 8+ messages in thread* [U-Boot] [PATCH] Fix spelling of "occurred".
2016-05-01 18:55 ` Simon Glass
@ 2016-05-01 23:34 ` Scott Wood
2016-05-02 18:57 ` Simon Glass
0 siblings, 1 reply; 8+ messages in thread
From: Scott Wood @ 2016-05-01 23:34 UTC (permalink / raw)
To: u-boot
On Sun, 2016-05-01 at 12:55 -0600, Simon Glass wrote:
> Hi,
>
> On 30 April 2016 at 20:18, Vagrant Cascadian <vagrant@debian.org> wrote:
>
> Please can you add a commit message?
I don't understand these "empty/missing commit message" remarks when there's a
one-line changelog (in the subject). Do you seriously want the same line
repeated twice in the git commit, just so something shows up in the body of
the e-mail? It's one thing if the commit warrants more than a single line
(though it's still not accurate to say that the changelog is completely
absent), but a spelling fix is about as trivial as it gets...
-Scott
^ permalink raw reply [flat|nested] 8+ messages in thread
* [U-Boot] [PATCH] Fix spelling of "occurred".
2016-05-01 23:34 ` Scott Wood
@ 2016-05-02 18:57 ` Simon Glass
2016-05-02 19:03 ` Scott Wood
0 siblings, 1 reply; 8+ messages in thread
From: Simon Glass @ 2016-05-02 18:57 UTC (permalink / raw)
To: u-boot
Hi Scott,
On 1 May 2016 at 17:34, Scott Wood <oss@buserror.net> wrote:
> On Sun, 2016-05-01 at 12:55 -0600, Simon Glass wrote:
>> Hi,
>>
>> On 30 April 2016 at 20:18, Vagrant Cascadian <vagrant@debian.org> wrote:
>>
>> Please can you add a commit message?
>
> I don't understand these "empty/missing commit message" remarks when there's a
> one-line changelog (in the subject). Do you seriously want the same line
> repeated twice in the git commit, just so something shows up in the body of
> the e-mail? It's one thing if the commit warrants more than a single line
> (though it's still not accurate to say that the changelog is completely
> absent), but a spelling fix is about as trivial as it gets...
> -Scott
>
It only takes a few seconds to add a commit message and I think it is
good practice.
But if you want to allow commits with no message (other than
merge/release tag), then we should document it here:
http://www.denx.de/wiki/U-Boot/Patches
Regards,
Simon
^ permalink raw reply [flat|nested] 8+ messages in thread
* [U-Boot] [PATCH] Fix spelling of "occurred".
2016-05-02 18:57 ` Simon Glass
@ 2016-05-02 19:03 ` Scott Wood
2016-05-02 19:26 ` Simon Glass
0 siblings, 1 reply; 8+ messages in thread
From: Scott Wood @ 2016-05-02 19:03 UTC (permalink / raw)
To: u-boot
On Mon, 2016-05-02 at 12:57 -0600, Simon Glass wrote:
> Hi Scott,
>
> On 1 May 2016 at 17:34, Scott Wood <oss@buserror.net> wrote:
> > On Sun, 2016-05-01 at 12:55 -0600, Simon Glass wrote:
> > > Hi,
> > >
> > > On 30 April 2016 at 20:18, Vagrant Cascadian <vagrant@debian.org> wrote:
> > >
> > > Please can you add a commit message?
> >
> > I don't understand these "empty/missing commit message" remarks when
> > there's a
> > one-line changelog (in the subject). Do you seriously want the same line
> > repeated twice in the git commit, just so something shows up in the body
> > of
> > the e-mail? It's one thing if the commit warrants more than a single line
> > (though it's still not accurate to say that the changelog is completely
> > absent), but a spelling fix is about as trivial as it gets...
> > -Scott
> >
>
> It only takes a few seconds to add a commit message and I think it is
> good practice.
>
> But if you want to allow commits with no message (other than
> merge/release tag), then we should document it here:
> http://www.denx.de/wiki/U-Boot/Patches
There is a commit message. It is 'Fix spelling of "occurred"'.
And that wiki link explicitly says, "Put a detailed description after the
summary and blank line. If the summary line is sufficient to describe the
change, you can omit the blank line and detailed description."
-Scott
^ permalink raw reply [flat|nested] 8+ messages in thread
* [U-Boot] [PATCH] Fix spelling of "occurred".
2016-05-02 19:03 ` Scott Wood
@ 2016-05-02 19:26 ` Simon Glass
2016-05-03 4:29 ` Scott Wood
0 siblings, 1 reply; 8+ messages in thread
From: Simon Glass @ 2016-05-02 19:26 UTC (permalink / raw)
To: u-boot
Hi Scott,
On 2 May 2016 at 13:03, Scott Wood <oss@buserror.net> wrote:
> On Mon, 2016-05-02 at 12:57 -0600, Simon Glass wrote:
>> Hi Scott,
>>
>> On 1 May 2016 at 17:34, Scott Wood <oss@buserror.net> wrote:
>> > On Sun, 2016-05-01 at 12:55 -0600, Simon Glass wrote:
>> > > Hi,
>> > >
>> > > On 30 April 2016 at 20:18, Vagrant Cascadian <vagrant@debian.org> wrote:
>> > >
>> > > Please can you add a commit message?
>> >
>> > I don't understand these "empty/missing commit message" remarks when
>> > there's a
>> > one-line changelog (in the subject). Do you seriously want the same line
>> > repeated twice in the git commit, just so something shows up in the body
>> > of
>> > the e-mail? It's one thing if the commit warrants more than a single line
>> > (though it's still not accurate to say that the changelog is completely
>> > absent), but a spelling fix is about as trivial as it gets...
>> > -Scott
>> >
>>
>> It only takes a few seconds to add a commit message and I think it is
>> good practice.
>>
>> But if you want to allow commits with no message (other than
>> merge/release tag), then we should document it here:
>> http://www.denx.de/wiki/U-Boot/Patches
>
> There is a commit message. It is 'Fix spelling of "occurred"'.
>
> And that wiki link explicitly says, "Put a detailed description after the
> summary and blank line. If the summary line is sufficient to describe the
> change, you can omit the blank line and detailed description."
OK I made a little update to make it more limited:
"Put a detailed description after the summary and blank line. If the
summary line is sufficient to describe the change (e.g. it is a
trivial spelling correction or whitespace update), you can omit the
blank line and detailed description."
Does that seem reasonable?
We should avoid submitting new drivers and forgetting a commit
message. Also some fixes are trivial (e.g. adding 1 to a result) but
the reason for them needs to be explained. I'd rather have a hard and
fast rule but I agree in some cases it doesn't make sense and it needs
to be flexible.
Sorry if I'm being picky on this. I've spent a *lot* of time over the
past few years digging into code and finding changes that are not
self-explanatory. That's why I am keen on people adding comments to
header files for API functions and struct members
I think it helps for people to answer the question 'why should this
code be submitted?' when writing a commit message. For the record. in
this case, I would have added a message something like 'Occurred is
spelled incorrectly in a number of places. Fix these up to provide
consistency'.
Regards,
Simon
^ permalink raw reply [flat|nested] 8+ messages in thread
* [U-Boot] [PATCH] Fix spelling of "occurred".
2016-05-02 19:26 ` Simon Glass
@ 2016-05-03 4:29 ` Scott Wood
0 siblings, 0 replies; 8+ messages in thread
From: Scott Wood @ 2016-05-03 4:29 UTC (permalink / raw)
To: u-boot
On Mon, 2016-05-02 at 13:26 -0600, Simon Glass wrote:
> Hi Scott,
>
> On 2 May 2016 at 13:03, Scott Wood <oss@buserror.net> wrote:
> > On Mon, 2016-05-02 at 12:57 -0600, Simon Glass wrote:
> > > Hi Scott,
> > >
> > > On 1 May 2016 at 17:34, Scott Wood <oss@buserror.net> wrote:
> > > > On Sun, 2016-05-01 at 12:55 -0600, Simon Glass wrote:
> > > > > Hi,
> > > > >
> > > > > On 30 April 2016 at 20:18, Vagrant Cascadian <vagrant@debian.org>
> > > > > wrote:
> > > > >
> > > > > Please can you add a commit message?
> > > >
> > > > I don't understand these "empty/missing commit message" remarks when
> > > > there's a
> > > > one-line changelog (in the subject). Do you seriously want the same
> > > > line
> > > > repeated twice in the git commit, just so something shows up in the
> > > > body
> > > > of
> > > > the e-mail? It's one thing if the commit warrants more than a single
> > > > line
> > > > (though it's still not accurate to say that the changelog is
> > > > completely
> > > > absent), but a spelling fix is about as trivial as it gets...
> > > > -Scott
> > > >
> > >
> > > It only takes a few seconds to add a commit message and I think it is
> > > good practice.
> > >
> > > But if you want to allow commits with no message (other than
> > > merge/release tag), then we should document it here:
> > > http://www.denx.de/wiki/U-Boot/Patches
> >
> > There is a commit message. It is 'Fix spelling of "occurred"'.
> >
> > And that wiki link explicitly says, "Put a detailed description after the
> > summary and blank line. If the summary line is sufficient to describe the
> > change, you can omit the blank line and detailed description."
>
> OK I made a little update to make it more limited:
>
> "Put a detailed description after the summary and blank line. If the
> summary line is sufficient to describe the change (e.g. it is a
> trivial spelling correction or whitespace update), you can omit the
> blank line and detailed description."
>
> Does that seem reasonable?
It's an example so it doesn't really limit anything -- if it did, I think
that'd be way too specific. The criteria should be whether the single line
adequately describes the patch (including justification, etc. if non-obvious).
If it doesn't, then ask for a more detailed changelog, the same as you would
if it contained more than one line but still didn't adequately describe the
patch.
> We should avoid submitting new drivers and forgetting a commit
> message.
I could see a new driver sometimes reasonably having a one-line commit message
(which is not the same as "forgetting a commit message"). It's a driver for
hardware <foo>. If there's nothing unusual to be noted about the driver,
known limitations, etc. then what else is there to say?
> Also some fixes are trivial (e.g. adding 1 to a result) but
> the reason for them needs to be explained.
Yes, but simply mandating text beyond the summary line is likely to get you
stuff like:
foo: Add 1 to result of blah()
Add one to the result of blah().
Signed-off-by: whoever
The problem there is not brevity, it's that important information is missing.
> Sorry if I'm being picky on this. I've spent a *lot* of time over the
> past few years digging into code and finding changes that are not
> self-explanatory. That's why I am keen on people adding comments to
> header files for API functions and struct members
Yes, we could definitely use more API/struct documentation. I have no problem
with pushing for better changelogs in cases where more information would be
helpful. But we shouldn't mandate the changelog equivalent of:
i++; /* add one to i */
> I think it helps for people to answer the question 'why should this
> code be submitted?' when writing a commit message. For the record. in
> this case, I would have added a message something like 'Occurred is
> spelled incorrectly in a number of places. Fix these up to provide
> consistency'.
OK, but "fix spelling" followed by a diff showing the misspellings conveys the
same information quite clearly.
-Scott
^ permalink raw reply [flat|nested] 8+ messages in thread
* [U-Boot] Fix spelling of "occurred".
2016-05-01 2:18 [U-Boot] [PATCH] Fix spelling of "occurred" Vagrant Cascadian
2016-05-01 18:55 ` Simon Glass
@ 2016-05-02 23:32 ` Tom Rini
1 sibling, 0 replies; 8+ messages in thread
From: Tom Rini @ 2016-05-02 23:32 UTC (permalink / raw)
To: u-boot
On Sat, Apr 30, 2016 at 07:18:00PM -0700, Vagrant Cascadian wrote:
> Signed-off-by: Vagrant Cascadian <vagrant@debian.org>
> Reviewed-by: Simon Glass <sjg@chromium.org>
Applied to u-boot/master, thanks!
--
Tom
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 819 bytes
Desc: Digital signature
URL: <http://lists.denx.de/pipermail/u-boot/attachments/20160502/8e0534a5/attachment.sig>
^ permalink raw reply [flat|nested] 8+ messages in thread
end of thread, other threads:[~2016-05-03 4:29 UTC | newest]
Thread overview: 8+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2016-05-01 2:18 [U-Boot] [PATCH] Fix spelling of "occurred" Vagrant Cascadian
2016-05-01 18:55 ` Simon Glass
2016-05-01 23:34 ` Scott Wood
2016-05-02 18:57 ` Simon Glass
2016-05-02 19:03 ` Scott Wood
2016-05-02 19:26 ` Simon Glass
2016-05-03 4:29 ` Scott Wood
2016-05-02 23:32 ` [U-Boot] " Tom Rini
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox