Re: [PATCH] docs: deprecated.rst: Clean up fall-through details

[Jonathan Corbet]

On Wed, 4 Mar 2020 11:03:24 -0800
Kees Cook <keescook@xxxxxxxxxxxx> wrote:

> Add example of fall-through, list-ify the case ending statements, and
> adjust the markup for links and readability. While here, adjust
> strscpy() details to mention strscpy_pad().
> 
> Signed-off-by: Kees Cook <keescook@xxxxxxxxxxxx>

Applied, thanks.  But ...

> ---
>  Documentation/process/deprecated.rst | 48 +++++++++++++++++-----------
>  1 file changed, 29 insertions(+), 19 deletions(-)
> 
> diff --git a/Documentation/process/deprecated.rst b/Documentation/process/deprecated.rst
> index 179f2a5625a0..f9f196d3a69b 100644
> --- a/Documentation/process/deprecated.rst
> +++ b/Documentation/process/deprecated.rst
> @@ -94,8 +94,8 @@ and other misbehavior due to the missing termination. It also NUL-pads the
>  destination buffer if the source contents are shorter than the destination
>  buffer size, which may be a needless performance penalty for callers using
>  only NUL-terminated strings. The safe replacement is :c:func:`strscpy`.
> -(Users of :c:func:`strscpy` still needing NUL-padding will need an
> -explicit :c:func:`memset` added.)
> +(Users of :c:func:`strscpy` still needing NUL-padding should instead
> +use strscpy_pad().)

:c:func: usage should really be stomped on when we encounter it.  There's
a few in this file; I'll tack on a quick patch making them go away.

jon