From: Joe Perches <joe@perches.com> To: Johan Hovold <johan@kernel.org>, Xiaofei Tan <tanxiaofei@huawei.com> Cc: gregkh@linuxfoundation.org, jirislaby@kernel.org, linux-kernel@vger.kernel.org, linuxppc-dev@lists.ozlabs.org, linuxarm@openeuler.org Subject: Re: [PATCH 6/9] tty: hvc_console: Fix coding style issues of block comments Date: Thu, 20 May 2021 08:21:39 -0700 [thread overview] Message-ID: <3173f7f10e0c212c8c828d9ca4450927f757e7d2.camel@perches.com> (raw) In-Reply-To: <YKYcFfKiHT39Gyey@hovoldconsulting.com> On Thu, 2021-05-20 at 10:21 +0200, Johan Hovold wrote: > On Tue, May 18, 2021 at 12:01:22PM +0800, Xiaofei Tan wrote: > > On 2021/5/17 22:15, Johan Hovold wrote: > > > On Mon, May 17, 2021 at 02:37:10PM +0800, Xiaofei Tan wrote: > > > > Fix coding style issues of block comments, reported by checkpatch.pl. > > > > Besides, add a period at the end of the sentenses. [] > > > > diff --git a/drivers/tty/hvc/hvc_console.c b/drivers/tty/hvc/hvc_console.c [] > > > > @@ -177,7 +177,8 @@ static void hvc_console_print(struct console *co, const char *b, > > > > r = cons_ops[index]->put_chars(vtermnos[index], c, i); > > > > if (r <= 0) { > > > > /* throw away characters on error > > > > - * but spin in case of -EAGAIN */ > > > > + * but spin in case of -EAGAIN. > > > > + */ > > > > > > How is this an improvement? First, the multi-line comment style is > > > > > > /* > > > * ... > > > */ > > > > > > > Yes, mostly we use this style. I can follow it if new version is needed. > > This is the preferred style outside of networking. > > > BTW, How about add the '/*' check into checkpatch.pl? > > Checkpatch already has too many checks IMO I sometimes agree. What checkpatch messages do you think are excessive? > and I'm a bit surprised that > it doesn't check this already. Perhaps it's because you used the -f to > run checkpatch on in-kernel code, which you should not. Likely not. If it was run on a suggested patch, checkpatch doesn't emit many messages on unmodified patch context lines. And it shouldn't. > it's just that you > introduce noise in the logs and do pointless changes of context which > makes it harder to use tools like git blame and makes backporting harder > for no good reason. Pretty pointless metric IMO. Context changes in comments are mostly harmless. IMO: backporting of these sorts non-bug fix changes is done _far_ too often.
WARNING: multiple messages have this Message-ID (diff)
From: Joe Perches <joe@perches.com> To: Johan Hovold <johan@kernel.org>, Xiaofei Tan <tanxiaofei@huawei.com> Cc: gregkh@linuxfoundation.org, linuxppc-dev@lists.ozlabs.org, jirislaby@kernel.org, linux-kernel@vger.kernel.org, linuxarm@openeuler.org Subject: Re: [PATCH 6/9] tty: hvc_console: Fix coding style issues of block comments Date: Thu, 20 May 2021 08:21:39 -0700 [thread overview] Message-ID: <3173f7f10e0c212c8c828d9ca4450927f757e7d2.camel@perches.com> (raw) In-Reply-To: <YKYcFfKiHT39Gyey@hovoldconsulting.com> On Thu, 2021-05-20 at 10:21 +0200, Johan Hovold wrote: > On Tue, May 18, 2021 at 12:01:22PM +0800, Xiaofei Tan wrote: > > On 2021/5/17 22:15, Johan Hovold wrote: > > > On Mon, May 17, 2021 at 02:37:10PM +0800, Xiaofei Tan wrote: > > > > Fix coding style issues of block comments, reported by checkpatch.pl. > > > > Besides, add a period at the end of the sentenses. [] > > > > diff --git a/drivers/tty/hvc/hvc_console.c b/drivers/tty/hvc/hvc_console.c [] > > > > @@ -177,7 +177,8 @@ static void hvc_console_print(struct console *co, const char *b, > > > > r = cons_ops[index]->put_chars(vtermnos[index], c, i); > > > > if (r <= 0) { > > > > /* throw away characters on error > > > > - * but spin in case of -EAGAIN */ > > > > + * but spin in case of -EAGAIN. > > > > + */ > > > > > > How is this an improvement? First, the multi-line comment style is > > > > > > /* > > > * ... > > > */ > > > > > > > Yes, mostly we use this style. I can follow it if new version is needed. > > This is the preferred style outside of networking. > > > BTW, How about add the '/*' check into checkpatch.pl? > > Checkpatch already has too many checks IMO I sometimes agree. What checkpatch messages do you think are excessive? > and I'm a bit surprised that > it doesn't check this already. Perhaps it's because you used the -f to > run checkpatch on in-kernel code, which you should not. Likely not. If it was run on a suggested patch, checkpatch doesn't emit many messages on unmodified patch context lines. And it shouldn't. > it's just that you > introduce noise in the logs and do pointless changes of context which > makes it harder to use tools like git blame and makes backporting harder > for no good reason. Pretty pointless metric IMO. Context changes in comments are mostly harmless. IMO: backporting of these sorts non-bug fix changes is done _far_ too often.
next prev parent reply other threads:[~2021-05-20 15:22 UTC|newest] Thread overview: 40+ messages / expand[flat|nested] mbox.gz Atom feed top 2021-05-17 6:37 [PATCH 0/9] tty: hvc_console: Fix some coding style issues Xiaofei Tan 2021-05-17 6:37 ` Xiaofei Tan 2021-05-17 6:37 ` [PATCH 1/9] tty: hvc_console: Fix spaces required around that '=' Xiaofei Tan 2021-05-17 6:37 ` Xiaofei Tan 2021-05-17 6:37 ` [PATCH 2/9] tty: hvc_console: Fix "foo * bar" should be "foo *bar" Xiaofei Tan 2021-05-17 6:37 ` Xiaofei Tan 2021-05-17 6:37 ` [PATCH 3/9] tty: hvc_console: Remove trailing whitespace Xiaofei Tan 2021-05-17 6:37 ` Xiaofei Tan 2021-05-17 6:37 ` [PATCH 4/9] tty: hvc_console: Fix issues of code indent should use tabs Xiaofei Tan 2021-05-17 6:37 ` Xiaofei Tan 2021-05-17 6:37 ` [PATCH 5/9] tty: hvc_console: Delete spaces prohibited around open parenthesis '(' and ')' Xiaofei Tan 2021-05-17 6:37 ` Xiaofei Tan 2021-05-17 6:37 ` [PATCH 6/9] tty: hvc_console: Fix coding style issues of block comments Xiaofei Tan 2021-05-17 6:37 ` Xiaofei Tan 2021-05-17 14:15 ` Johan Hovold 2021-05-17 14:15 ` Johan Hovold 2021-05-18 4:01 ` Xiaofei Tan 2021-05-18 4:01 ` Xiaofei Tan 2021-05-20 8:21 ` Johan Hovold 2021-05-20 8:21 ` Johan Hovold 2021-05-20 13:21 ` Xiaofei Tan 2021-05-20 13:21 ` Xiaofei Tan 2021-05-20 13:52 ` Johan Hovold 2021-05-20 13:52 ` Johan Hovold 2021-05-21 2:23 ` Xiaofei Tan 2021-05-21 2:23 ` Xiaofei Tan 2021-05-20 15:21 ` Joe Perches [this message] 2021-05-20 15:21 ` Joe Perches 2021-05-21 8:44 ` Johan Hovold 2021-05-21 8:44 ` Johan Hovold 2021-05-17 6:37 ` [PATCH 7/9] tty: hvc_console: Add a blank line after declarations Xiaofei Tan 2021-05-17 6:37 ` Xiaofei Tan 2021-05-17 6:37 ` [PATCH 8/9] tty: hvc_console: Remove the repeated words 'no' and 'from' Xiaofei Tan 2021-05-17 6:37 ` Xiaofei Tan 2021-05-17 6:37 ` [PATCH 9/9] tty: hvc_console: Move open brace { on the previous line Xiaofei Tan 2021-05-17 6:37 ` Xiaofei Tan 2021-05-20 15:11 ` [PATCH 0/9] tty: hvc_console: Fix some coding style issues Greg KH 2021-05-20 15:11 ` Greg KH 2021-05-21 2:18 ` Xiaofei Tan 2021-05-21 2:18 ` Xiaofei Tan
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=3173f7f10e0c212c8c828d9ca4450927f757e7d2.camel@perches.com \ --to=joe@perches.com \ --cc=gregkh@linuxfoundation.org \ --cc=jirislaby@kernel.org \ --cc=johan@kernel.org \ --cc=linux-kernel@vger.kernel.org \ --cc=linuxarm@openeuler.org \ --cc=linuxppc-dev@lists.ozlabs.org \ --cc=tanxiaofei@huawei.com \ /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: linkBe sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes, see mirroring instructions on how to clone and mirror all data and code used by this external index.