[PATCH] docs: remove mention of ENABLE_MUST_CHECK

[PATCH] docs: remove mention of ENABLE_MUST_CHECK

[Miguel Ojeda]

We removed ENABLE_MUST_CHECK in 196793946264 ("Compiler Attributes:
remove CONFIG_ENABLE_MUST_CHECK"), so let's remove docs' mentions.

At the same time, fix the outdated text related to
ENABLE_WARN_DEPRECATED that wasn't removed in 3337d5cfe5e08
("configs: get rid of obsolete CONFIG_ENABLE_WARN_DEPRECATED").

Finally, reflow the paragraph.

Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
---
A couple translations (it and zh) should consider updating this
too, since they also have the mention -- Cc'ing their maintainers.

 Documentation/process/4.Coding.rst | 6 ++----
 1 file changed, 2 insertions(+), 4 deletions(-)

diff --git a/Documentation/process/4.Coding.rst b/Documentation/process/4.Coding.rst
index c27e59d2f702..0825dc496f22 100644
--- a/Documentation/process/4.Coding.rst
+++ b/Documentation/process/4.Coding.rst
@@ -249,10 +249,8 @@ features; most of these are found in the "kernel hacking" submenu.  Several
 of these options should be turned on for any kernel used for development or
 testing purposes.  In particular, you should turn on:
 
- - ENABLE_MUST_CHECK and FRAME_WARN to get an
-   extra set of warnings for problems like the use of deprecated interfaces
-   or ignoring an important return value from a function.  The output
-   generated by these warnings can be verbose, but one need not worry about
+ - FRAME_WARN to get warnings for stack frames larger than a given amount.
+   The output generated can be verbose, but one need not worry about
    warnings from other parts of the kernel.
 
  - DEBUG_OBJECTS will add code to track the lifetime of various objects
-- 
2.29.2

Re: [PATCH] docs: remove mention of ENABLE_MUST_CHECK

[Nick Desaulniers]

On Mon, Jan 4, 2021 at 9:58 PM Miguel Ojeda <ojeda@kernel.org> wrote:
>
> We removed ENABLE_MUST_CHECK in 196793946264 ("Compiler Attributes:
> remove CONFIG_ENABLE_MUST_CHECK"), so let's remove docs' mentions.
>
> At the same time, fix the outdated text related to
> ENABLE_WARN_DEPRECATED that wasn't removed in 3337d5cfe5e08
> ("configs: get rid of obsolete CONFIG_ENABLE_WARN_DEPRECATED").
>
> Finally, reflow the paragraph.
>
> Signed-off-by: Miguel Ojeda <ojeda@kernel.org>

Thanks for the patch!

Reviewed-by: Nick Desaulniers <ndesaulniers@google.com>

> ---
> A couple translations (it and zh) should consider updating this
> too, since they also have the mention -- Cc'ing their maintainers.
>
>  Documentation/process/4.Coding.rst | 6 ++----
>  1 file changed, 2 insertions(+), 4 deletions(-)
>
> diff --git a/Documentation/process/4.Coding.rst b/Documentation/process/4.Coding.rst
> index c27e59d2f702..0825dc496f22 100644
> --- a/Documentation/process/4.Coding.rst
> +++ b/Documentation/process/4.Coding.rst
> @@ -249,10 +249,8 @@ features; most of these are found in the "kernel hacking" submenu.  Several
>  of these options should be turned on for any kernel used for development or
>  testing purposes.  In particular, you should turn on:
>
> - - ENABLE_MUST_CHECK and FRAME_WARN to get an
> -   extra set of warnings for problems like the use of deprecated interfaces
> -   or ignoring an important return value from a function.  The output
> -   generated by these warnings can be verbose, but one need not worry about
> + - FRAME_WARN to get warnings for stack frames larger than a given amount.
> +   The output generated can be verbose, but one need not worry about
>     warnings from other parts of the kernel.
>
>   - DEBUG_OBJECTS will add code to track the lifetime of various objects
> --
> 2.29.2
>


-- 
Thanks,
~Nick Desaulniers

Re: [PATCH] docs: remove mention of ENABLE_MUST_CHECK

[Nathan Chancellor]

On Tue, Jan 05, 2021 at 06:58:15AM +0100, Miguel Ojeda wrote:
> We removed ENABLE_MUST_CHECK in 196793946264 ("Compiler Attributes:
> remove CONFIG_ENABLE_MUST_CHECK"), so let's remove docs' mentions.
> 
> At the same time, fix the outdated text related to
> ENABLE_WARN_DEPRECATED that wasn't removed in 3337d5cfe5e08
> ("configs: get rid of obsolete CONFIG_ENABLE_WARN_DEPRECATED").
> 
> Finally, reflow the paragraph.
> 
> Signed-off-by: Miguel Ojeda <ojeda@kernel.org>

Reviewed-by: Nathan Chancellor <natechancellor@gmail.com>

> ---
> A couple translations (it and zh) should consider updating this
> too, since they also have the mention -- Cc'ing their maintainers.
> 
>  Documentation/process/4.Coding.rst | 6 ++----
>  1 file changed, 2 insertions(+), 4 deletions(-)
> 
> diff --git a/Documentation/process/4.Coding.rst b/Documentation/process/4.Coding.rst
> index c27e59d2f702..0825dc496f22 100644
> --- a/Documentation/process/4.Coding.rst
> +++ b/Documentation/process/4.Coding.rst
> @@ -249,10 +249,8 @@ features; most of these are found in the "kernel hacking" submenu.  Several
>  of these options should be turned on for any kernel used for development or
>  testing purposes.  In particular, you should turn on:
>  
> - - ENABLE_MUST_CHECK and FRAME_WARN to get an
> -   extra set of warnings for problems like the use of deprecated interfaces
> -   or ignoring an important return value from a function.  The output
> -   generated by these warnings can be verbose, but one need not worry about
> + - FRAME_WARN to get warnings for stack frames larger than a given amount.
> +   The output generated can be verbose, but one need not worry about
>     warnings from other parts of the kernel.
>  
>   - DEBUG_OBJECTS will add code to track the lifetime of various objects
> -- 
> 2.29.2
> 

Re: [PATCH] docs: remove mention of ENABLE_MUST_CHECK

[Jonathan Corbet]

On Tue, 5 Jan 2021 06:58:15 +0100
Miguel Ojeda <ojeda@kernel.org> wrote:

> We removed ENABLE_MUST_CHECK in 196793946264 ("Compiler Attributes:
> remove CONFIG_ENABLE_MUST_CHECK"), so let's remove docs' mentions.
> 
> At the same time, fix the outdated text related to
> ENABLE_WARN_DEPRECATED that wasn't removed in 3337d5cfe5e08
> ("configs: get rid of obsolete CONFIG_ENABLE_WARN_DEPRECATED").
> 
> Finally, reflow the paragraph.
> 
> Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
> ---
> A couple translations (it and zh) should consider updating this
> too, since they also have the mention -- Cc'ing their maintainers.
> 
>  Documentation/process/4.Coding.rst | 6 ++----
>  1 file changed, 2 insertions(+), 4 deletions(-)

Applied, thanks.

jon