[PATCH] docs: remove mention of ENABLE_MUST_CHECK

Subsystems: documentation, documentation process, the rest

STALE2034d LANDED

Landed in mainline as 0ef597c3ac49 on 2021-01-07.

4 messages, 4 authors, 2021-01-07 · open the first message on its own page

[PATCH] docs: remove mention of ENABLE_MUST_CHECK

From: Miguel Ojeda <ojeda@kernel.org>
Date: 2021-01-05 05:59:25

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

From: Nick Desaulniers <ndesaulniers@google.com>
Date: 2021-01-05 20:28:54

On Mon, Jan 4, 2021 at 9:58 PM Miguel Ojeda [off-list ref] 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>
quoted hunk
---
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

From: Nathan Chancellor <hidden>
Date: 2021-01-05 22:26:16

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 <redacted>
quoted hunk
---
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

From: Jonathan Corbet <corbet@lwn.net>
Date: 2021-01-07 21:43:11

On Tue, 5 Jan 2021 06:58:15 +0100
Miguel Ojeda [off-list ref] 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
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help