Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Message-ID: <7a935730-f3a5-0b1f-2bdc-a629711a3a01@linux.ibm.com>
Date:   Tue, 21 Jun 2022 17:44:43 +0200
MIME-Version: 1.0
User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:91.0)
 Gecko/20100101 Thunderbird/91.9.1
Subject: Re: [PATCH] net: s390: drop unexpected word "the" in the comments
Content-Language: en-US
To:     Joe Perches <joe@perches.com>, Jiang Jian <jiangjian@cdjrlc.com>
Cc:     wenjia@linux.ibm.com, hca@linux.ibm.com, gor@linux.ibm.com,
        agordeev@linux.ibm.com, borntraeger@linux.ibm.com,
        svens@linux.ibm.com, linux-s390@vger.kernel.org,
        netdev@vger.kernel.org, linux-kernel@vger.kernel.org
References: <20220621113740.103317-1-jiangjian@cdjrlc.com>
 <09b411b2-0e1f-26d5-c0ea-8ee6504bdcfd@linux.ibm.com>
 <a502003f9ba31c660ddb9c9d8683b7b2a01d12f7.camel@perches.com>
From:   Alexandra Winter <wintera@linux.ibm.com>
In-Reply-To: <a502003f9ba31c660ddb9c9d8683b7b2a01d12f7.camel@perches.com>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 7bit
Precedence: bulk


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@linux.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.