The RISC-V architecture has a register named the "Supervisor Exception
Program Counter", or "sepc". This abbreviation triggers
checkpatch.pl's misspelling detector, resulting in noise in the
checkpatch output. The risk that this noise could cause more useful
warnings to be missed seems to outweigh the harm of an occasional
misspelling of "spec". Thus drop the "sepc" entry from the
misspelling list.
Signed-off-by: Paul Walmsley <[email protected]>
Cc: Andrew Morton <[email protected]>
---
scripts/spelling.txt | 1 -
1 file changed, 1 deletion(-)
diff --git a/scripts/spelling.txt b/scripts/spelling.txt
index 86b87332b9e5..5ae83ce31902 100644
--- a/scripts/spelling.txt
+++ b/scripts/spelling.txt
@@ -1145,7 +1145,6 @@ senarios||scenarios
sentivite||sensitive
separatly||separately
sepcify||specify
-sepc||spec
seperated||separated
seperately||separately
seperate||separate
--
2.20.1
On Sat, 2019-05-18 at 14:00 -0700, Paul Walmsley wrote:
> The RISC-V architecture has a register named the "Supervisor Exception
> Program Counter", or "sepc". This abbreviation triggers
> checkpatch.pl's misspelling detector, resulting in noise in the
> checkpatch output. The risk that this noise could cause more useful
> warnings to be missed seems to outweigh the harm of an occasional
> misspelling of "spec". Thus drop the "sepc" entry from the
> misspelling list.
I would agree if you first fixed the existing sepc/spec
and sepcific/specific typos.
arch/powerpc/kvm/book3s_xics.c: * a pending interrupt, this is a SW error and PAPR sepcifies
arch/unicore32/include/mach/regs-gpio.h: * Sepcial Voltage Detect Reg GPIO_GPIR.
drivers/net/wireless/realtek/rtlwifi/wifi.h:/* Ref: 802.11i sepc D10.0 7.3.2.25.1
drivers/scsi/lpfc/lpfc_init.c: /* Stop any OneConnect device sepcific driver timers */
drivers/staging/rtl8723bs/hal/rtl8723b_phycfg.c:* OverView: Read "sepcific bits" from BB register
On Sat, 18 May 2019, Joe Perches wrote:
> On Sat, 2019-05-18 at 14:00 -0700, Paul Walmsley wrote:
> > The RISC-V architecture has a register named the "Supervisor Exception
> > Program Counter", or "sepc". This abbreviation triggers
> > checkpatch.pl's misspelling detector, resulting in noise in the
> > checkpatch output. The risk that this noise could cause more useful
> > warnings to be missed seems to outweigh the harm of an occasional
> > misspelling of "spec". Thus drop the "sepc" entry from the
> > misspelling list.
>
> I would agree if you first fixed the existing sepc/spec
> and sepcific/specific typos.
>
> arch/powerpc/kvm/book3s_xics.c: * a pending interrupt, this is a SW error and PAPR sepcifies
> arch/unicore32/include/mach/regs-gpio.h: * Sepcial Voltage Detect Reg GPIO_GPIR.
> drivers/scsi/lpfc/lpfc_init.c: /* Stop any OneConnect device sepcific driver timers */
> drivers/staging/rtl8723bs/hal/rtl8723b_phycfg.c:* OverView: Read "sepcific bits" from BB register
> drivers/net/wireless/realtek/rtlwifi/wifi.h:/* Ref: 802.11i sepc D10.0 7.3.2.25.1
Your agreement shouldn't be needed for the patch I sent.
- Paul
On Sun, 19 May 2019 11:24:22 -0700 (PDT) Paul Walmsley <[email protected]> wrote:
> On Sat, 18 May 2019, Joe Perches wrote:
>
> > On Sat, 2019-05-18 at 14:00 -0700, Paul Walmsley wrote:
> > > The RISC-V architecture has a register named the "Supervisor Exception
> > > Program Counter", or "sepc". This abbreviation triggers
> > > checkpatch.pl's misspelling detector, resulting in noise in the
> > > checkpatch output. The risk that this noise could cause more useful
> > > warnings to be missed seems to outweigh the harm of an occasional
> > > misspelling of "spec". Thus drop the "sepc" entry from the
> > > misspelling list.
> >
> > I would agree if you first fixed the existing sepc/spec
> > and sepcific/specific typos.
> >
> > arch/powerpc/kvm/book3s_xics.c: * a pending interrupt, this is a SW error and PAPR sepcifies
> > arch/unicore32/include/mach/regs-gpio.h: * Sepcial Voltage Detect Reg GPIO_GPIR.
> > drivers/scsi/lpfc/lpfc_init.c: /* Stop any OneConnect device sepcific driver timers */
> > drivers/staging/rtl8723bs/hal/rtl8723b_phycfg.c:* OverView: Read "sepcific bits" from BB register
> > drivers/net/wireless/realtek/rtlwifi/wifi.h:/* Ref: 802.11i sepc D10.0 7.3.2.25.1
>
> Your agreement shouldn't be needed for the patch I sent.
I always find Joe's input to be very useful.
Here:
From: Andrew Morton <[email protected]>
Subject: scripts-spellingtxt-drop-sepc-from-the-misspelling-list-fix
fix existing "sepc" instances, per Joe
Cc: Joe Perches <[email protected]>
Cc: Paul Walmsley <[email protected]>
Signed-off-by: Andrew Morton <[email protected]>
---
arch/powerpc/kvm/book3s_xics.c | 2 +-
arch/unicore32/include/mach/regs-gpio.h | 2 +-
drivers/net/wireless/realtek/rtlwifi/wifi.h | 2 +-
drivers/scsi/lpfc/lpfc_init.c | 2 +-
drivers/staging/rtl8723bs/hal/rtl8723b_phycfg.c | 2 +-
5 files changed, 5 insertions(+), 5 deletions(-)
--- a/arch/powerpc/kvm/book3s_xics.c~scripts-spellingtxt-drop-sepc-from-the-misspelling-list-fix
+++ a/arch/powerpc/kvm/book3s_xics.c
@@ -830,7 +830,7 @@ static noinline int kvmppc_h_eoi(struct
*
* Note: If EOI is incorrectly used by SW to lower the CPPR
* value (ie more favored), we do not check for rejection of
- * a pending interrupt, this is a SW error and PAPR sepcifies
+ * a pending interrupt, this is a SW error and PAPR specifies
* that we don't have to deal with it.
*
* The sending of an EOI to the ICS is handled after the
--- a/arch/unicore32/include/mach/regs-gpio.h~scripts-spellingtxt-drop-sepc-from-the-misspelling-list-fix
+++ a/arch/unicore32/include/mach/regs-gpio.h
@@ -32,7 +32,7 @@
*/
#define GPIO_GEDR (PKUNITY_GPIO_BASE + 0x0018)
/*
- * Sepcial Voltage Detect Reg GPIO_GPIR.
+ * Special Voltage Detect Reg GPIO_GPIR.
*/
#define GPIO_GPIR (PKUNITY_GPIO_BASE + 0x0020)
--- a/drivers/net/wireless/realtek/rtlwifi/wifi.h~scripts-spellingtxt-drop-sepc-from-the-misspelling-list-fix
+++ a/drivers/net/wireless/realtek/rtlwifi/wifi.h
@@ -597,7 +597,7 @@ enum ht_channel_width {
HT_CHANNEL_WIDTH_MAX,
};
-/* Ref: 802.11i sepc D10.0 7.3.2.25.1
+/* Ref: 802.11i spec D10.0 7.3.2.25.1
* Cipher Suites Encryption Algorithms
*/
enum rt_enc_alg {
--- a/drivers/scsi/lpfc/lpfc_init.c~scripts-spellingtxt-drop-sepc-from-the-misspelling-list-fix
+++ a/drivers/scsi/lpfc/lpfc_init.c
@@ -2963,7 +2963,7 @@ lpfc_stop_hba_timers(struct lpfc_hba *ph
del_timer_sync(&phba->fcp_poll_timer);
break;
case LPFC_PCI_DEV_OC:
- /* Stop any OneConnect device sepcific driver timers */
+ /* Stop any OneConnect device specific driver timers */
lpfc_sli4_stop_fcf_redisc_wait_timer(phba);
break;
default:
--- a/drivers/staging/rtl8723bs/hal/rtl8723b_phycfg.c~scripts-spellingtxt-drop-sepc-from-the-misspelling-list-fix
+++ a/drivers/staging/rtl8723bs/hal/rtl8723b_phycfg.c
@@ -45,7 +45,7 @@ static u32 phy_CalculateBitShift(u32 Bit
/**
* Function: PHY_QueryBBReg
*
-* OverView: Read "sepcific bits" from BB register
+* OverView: Read "specific bits" from BB register
*
* Input:
* struct adapter * Adapter,
_
On Tue, 21 May 2019, Andrew Morton wrote:
> On Sun, 19 May 2019 11:24:22 -0700 (PDT) Paul Walmsley <[email protected]> wrote:
>
> > On Sat, 18 May 2019, Joe Perches wrote:
> >
> > > On Sat, 2019-05-18 at 14:00 -0700, Paul Walmsley wrote:
> > > > The RISC-V architecture has a register named the "Supervisor Exception
> > > > Program Counter", or "sepc". This abbreviation triggers
> > > > checkpatch.pl's misspelling detector, resulting in noise in the
> > > > checkpatch output. The risk that this noise could cause more useful
> > > > warnings to be missed seems to outweigh the harm of an occasional
> > > > misspelling of "spec". Thus drop the "sepc" entry from the
> > > > misspelling list.
> > >
> > > I would agree if you first fixed the existing sepc/spec
> > > and sepcific/specific typos.
> > >
> > > arch/powerpc/kvm/book3s_xics.c: * a pending interrupt, this is a SW error and PAPR sepcifies
> > > arch/unicore32/include/mach/regs-gpio.h: * Sepcial Voltage Detect Reg GPIO_GPIR.
> > > drivers/scsi/lpfc/lpfc_init.c: /* Stop any OneConnect device sepcific driver timers */
> > > drivers/staging/rtl8723bs/hal/rtl8723b_phycfg.c:* OverView: Read "sepcific bits" from BB register
> > > drivers/net/wireless/realtek/rtlwifi/wifi.h:/* Ref: 802.11i sepc D10.0 7.3.2.25.1
> >
> > Your agreement shouldn't be needed for the patch I sent.
>
> I always find Joe's input to be very useful.
>
> Here:
>
> From: Andrew Morton <[email protected]>
> Subject: scripts-spellingtxt-drop-sepc-from-the-misspelling-list-fix
>
> fix existing "sepc" instances, per Joe
>
> Cc: Joe Perches <[email protected]>
> Cc: Paul Walmsley <[email protected]>
> Signed-off-by: Andrew Morton <[email protected]>
Thanks Andrew. Sorry that you had to do it.
Reviewed-by: Paul Walmsley <[email protected]>
What troubled me about Joe's message is that it seems like poor kernel
developer precedent to block a fix for static analysis false positives to
fix comment spelling errors -- particularly considering that four out of
five of them were unrelated to the actual patch in question. While
comment spelling fixes are worthwhile, I think we should make sure that
the "tail doesn't wag the dog" by prioritizing code fixes first.
Reflecting on it on Sunday evening, if Joe had acked the patch, or added a
Reviewed-by, and asked whether I might send a patch to fix those spelling
errors, it probably would have gotten done.
I will try to do better next time,
- Paul
On Tue, 2019-05-21 at 21:47 -0700, Paul Walmsley wrote:
> On Tue, 21 May 2019, Andrew Morton wrote:
>
> > On Sun, 19 May 2019 11:24:22 -0700 (PDT) Paul Walmsley <[email protected]> wrote:
> >
> > > On Sat, 18 May 2019, Joe Perches wrote:
> > >
> > > > On Sat, 2019-05-18 at 14:00 -0700, Paul Walmsley wrote:
> > > > > The RISC-V architecture has a register named the "Supervisor Exception
> > > > > Program Counter", or "sepc". This abbreviation triggers
> > > > > checkpatch.pl's misspelling detector, resulting in noise in the
> > > > > checkpatch output. The risk that this noise could cause more useful
> > > > > warnings to be missed seems to outweigh the harm of an occasional
> > > > > misspelling of "spec". Thus drop the "sepc" entry from the
> > > > > misspelling list.
> > > >
> > > > I would agree if you first fixed the existing sepc/spec
> > > > and sepcific/specific typos.
> > > >
> > > > arch/powerpc/kvm/book3s_xics.c: * a pending interrupt, this is a SW error and PAPR sepcifies
> > > > arch/unicore32/include/mach/regs-gpio.h: * Sepcial Voltage Detect Reg GPIO_GPIR.
> > > > drivers/scsi/lpfc/lpfc_init.c: /* Stop any OneConnect device sepcific driver timers */
> > > > drivers/staging/rtl8723bs/hal/rtl8723b_phycfg.c:* OverView: Read "sepcific bits" from BB register
> > > > drivers/net/wireless/realtek/rtlwifi/wifi.h:/* Ref: 802.11i sepc D10.0 7.3.2.25.1
> > >
> > > Your agreement shouldn't be needed for the patch I sent.
> >
> > I always find Joe's input to be very useful.
> >
> > Here:
> >
> > From: Andrew Morton <[email protected]>
> > Subject: scripts-spellingtxt-drop-sepc-from-the-misspelling-list-fix
> >
> > fix existing "sepc" instances, per Joe
> >
> > Cc: Joe Perches <[email protected]>
> > Cc: Paul Walmsley <[email protected]>
> > Signed-off-by: Andrew Morton <[email protected]>
>
> Thanks Andrew. Sorry that you had to do it.
>
> Reviewed-by: Paul Walmsley <[email protected]>
>
> What troubled me about Joe's message is that it seems like poor kernel
> developer precedent to block a fix for static analysis false positives to
> fix comment spelling errors -- particularly considering that four out of
> five of them were unrelated to the actual patch in question. While
> comment spelling fixes are worthwhile, I think we should make sure that
> the "tail doesn't wag the dog" by prioritizing code fixes first.
I don't believe there is any tail wagging occurring here.
There is no code 'fix' in the original proposed patch.
It is, as described, effectively a subsystem specific
static analysis false positive avoidance patch. And the
static analysis tool's false positive report is not active
by default.
Any scripts/spelling.txt change like a sepc removal could
be overridden by using checkpatch's --codespell option.
btw:
I don't generally add acked-by or reviewed-by to patches
as I rather agree with Ted's position on these headers.
https://lore.kernel.org/lkml/[email protected]/
> I will try to do better next time,
Thanks.