lkml.org 
[lkml]   [2021]   [Aug]   [27]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
SubjectRe: [PATCH] docs: deprecated.rst: Clarify open-coded arithmetic with literals
From
Date


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

\
 
 \ /
  Last update: 2021-08-27 21:41    [W:0.077 / U:0.024 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site