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;
From:   Len Baker <len.baker@gmx.com>
To:     Jonathan Corbet <corbet@lwn.net>, Kees Cook <keescook@chromium.org>
Cc:     Len Baker <len.baker@gmx.com>,
        "Gustavo A. R. Silva" <gustavoars@kernel.org>,
        Joe Perches <joe@perches.com>, linux-doc@vger.kernel.org,
        linux-kernel@vger.kernel.org, linux-hardening@vger.kernel.org
Subject: [PATCH v2] docs: deprecated.rst: Clarify open-coded arithmetic with literals
Date:   Sun, 29 Aug 2021 16:47:16 +0200
Message-Id: <20210829144716.2931-1-len.baker@gmx.com>
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable
Precedence: bulk

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.

Suggested-by: Kees Cook <keescook@chromium.org>
Signed-off-by: Len Baker <len.baker@gmx.com>
=2D--
Changelog v1 -> v2
 - Clarify the sentence by changing "keep <foo> out" with "avoid <foo>"
   (Joe Perches).

 Documentation/process/deprecated.rst | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/Documentation/process/deprecated.rst b/Documentation/process/=
deprecated.rst
index 9d83b8db8874..b5a8be914178 100644
=2D-- a/Documentation/process/deprecated.rst
+++ b/Documentation/process/deprecated.rst
@@ -60,7 +60,8 @@ smaller allocation being made than the caller was expect=
ing. 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 avoid the open-coded math idiom.)

 For example, do not use ``count * size`` as an argument, as in::

=2D-
2.25.1