linux-kernel - Re: [PATCH] net: s390: drop unexpected word "the" in the comments

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Date:   Tue, 21 Jun 2022 17:44:43 +0200
From:   Alexandra Winter <wintera@...ux.ibm.com>
To:     Joe Perches <joe@...ches.com>, Jiang Jian <jiangjian@...rlc.com>
Cc:     wenjia@...ux.ibm.com, hca@...ux.ibm.com, gor@...ux.ibm.com,
        agordeev@...ux.ibm.com, borntraeger@...ux.ibm.com,
        svens@...ux.ibm.com, linux-s390@...r.kernel.org,
        netdev@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH] net: s390: drop unexpected word "the" in the comments



On 21.06.22 17:01, Joe Perches wrote:
> On Tue, 2022-06-21 at 13:58 +0200, Alexandra Winter wrote:
>> On 21.06.22 13:37, Jiang Jian wrote:
>>> there is an unexpected word "the" in the comments that need to be dropped
> []
>>> * have to request a PCI to be sure the the PCI
>>> * have to request a PCI to be sure the PCI
> []
>>> diff --git a/drivers/s390/net/qeth_core_main.c b/drivers/s390/net/qeth_core_main.c
> []
>>> @@ -3565,7 +3565,7 @@ static void qeth_flush_buffers(struct qeth_qdio_out_q *queue, int index,
>>>  			if (!atomic_read(&queue->set_pci_flags_count)) {
>>>  				/*
>>>  				 * there's no outstanding PCI any more, so we
>>> -				 * have to request a PCI to be sure the the PCI
> 
> Might have intended "that the" and not "the the"
> 
>>> +				 * have to request a PCI to be sure the PCI
>>>  				 * will wake at some time in the future then we
>>>  				 * can flush packed buffers that might still be
>>>  				 * hanging around, which can happen if no
> 
> And this is a relatively long sentence.
> 
> Perhaps something like:
> 
> 			if (!atomic_read(&queue->set_pci_flags_count)) {
> 				/*
> 				 * there's no outstanding PCI any more so:
> 				 * o request a PCI to be sure that the PCI
> 				 *   will wake at some time in the future
> 				 * o flush packed buffers that might still be
> 				 *   hanging around (which can happen if no
> 				 *   further send was requested by the stack)
> 				 */
> 

No, don't remove the word 'then'
Not-Acked-by: Alexandra Winter <wintera@...ux.ibm.com>

Jiang, if you want to submit another patch, 
You could split the long sentence:
			if (!atomic_read(&queue->set_pci_flags_count)) {
 				/*
 				 * there's no outstanding PCI any more, so we
-				 * have to request a PCI to be sure the the PCI
- 				 * will wake at some time in the future then we
+				 * have to request a PCI to be sure the PCI
+ 				 * will wake at some time in the future. Then we
 				 * can flush packed buffers that might still be
 				 * hanging around, which can happen if no

I don't think this is a significant improvement in readability, though.