Re: [PATCH] docs: deprecated.rst: Clarify open-coded arithmetic with literals

[Len Baker]

Hi,

On Fri, Aug 27, 2021 at 12:06:18PM -0700, 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.
>
Understood. I will do this change and I will send a new version.
Thanks for the review.

Regards,
Len