Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
Subject: Re: [PATCH] docs: deprecated.rst: Clarify open-coded arithmetic with
 literals
To:     Joe Perches <joe@perches.com>, Len Baker <len.baker@gmx.com>,
        Jonathan Corbet <corbet@lwn.net>,
        Kees Cook <keescook@chromium.org>
Cc:     "Gustavo A. R. Silva" <gustavoars@kernel.org>,
        linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
        linux-hardening@vger.kernel.org
References: <20210827171226.2938-1-len.baker@gmx.com>
 <bd7487c725e15b0c20612a44ecf301637a60c157.camel@perches.com>
From:   "Gustavo A. R. Silva" <gustavo@embeddedor.com>
Message-ID: <9a338127-0b17-fa9e-96b6-578193ce96f4@embeddedor.com>
Date:   Fri, 27 Aug 2021 14:22:58 -0500
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101
 Thunderbird/78.11.0
MIME-Version: 1.0
In-Reply-To: <bd7487c725e15b0c20612a44ecf301637a60c157.camel@perches.com>
Content-Type: text/plain; charset=utf-8
Content-Language: en-US
Content-Transfer-Encoding: 8bit
Precedence: bulk


On 8/27/21 14:06, Joe Perches wrote:
> On Fri, 2021-08-27 at 19:12 +0200, Len Baker wrote:
>> Although using literals for size calculation in allocator arguments may
>> be harmless due to compiler warnings in case of overflows, it is better
>> to refactor the code to avoid the use of open-coded math idiom.
>>
>> So, clarify the preferred way in these cases.
> []
>> diff --git a/Documentation/process/deprecated.rst b/Documentation/process/deprecated.rst
> []
>> @@ -60,7 +60,8 @@ smaller allocation being made than the caller was expecting. Using those
>>  allocations could lead to linear overflows of heap memory and other
>>  misbehaviors. (One exception to this is literal values where the compiler
>>  can warn if they might overflow. Though using literals for arguments as
>> -suggested below is also harmless.)
>> +suggested below is also harmless. So, the preferred way in these cases is
>> +to refactor the code to keep the open-coded math idiom out.)
> 
> wordsmithing trivia:
> 
> 'keep <foo> out' is difficult to parse as 'keep' is generally a positive
> word but its meaning is later reversed with out.
> 
> 'avoid <foo>' maybe be better phrasing.

+1

--
Gustavo