Skip to contentSkip to conversation

docs: remove mention of ENABLE_MUST_CHECK

PATCH Applied Miguel Ojeda 4 participants 4 messages Jan 5, 2021 – Jan 7, 2021

Subsystems (2)
Documentation Documentation process
lore
Share & tools
lore

Miguel Ojeda

author
#0 lore raw

PATCH 1/1 docs: remove mention of ENABLE_MUST_CHECK

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 <[email protected]>

---
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(-)
Documentation/process/4.Coding.rst +2 -4
index c27e59d2f702..0825dc496f22 100644
@@ -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
Signature · 1 line
2.29.2
Reviewed-by on v1 1/1
#1 lore raw
Quoted 11 lines · 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 <[email protected]>

Thanks for the patch!

Reviewed-by Nick Desaulniers <[email protected]>
Quoted 27 lines

---
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(-)
Documentation/process/4.Coding.rst +2 -5
index c27e59d2f702..0825dc496f22 100644
@@ -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

Signature · 2 lines
Thanks,
~Nick Desaulniers
Reviewed-by on v1 1/1
#2 lore raw
In reply to Miguel Ojeda
Quoted 10 lines · 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 <[email protected]>
Reviewed-by Nathan Chancellor <[email protected]>
Quoted 27 lines

---
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(-)
Documentation/process/4.Coding.rst +2 -4
index c27e59d2f702..0825dc496f22 100644
@@ -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
Signature · 1 line
2.29.2
maintainer Applied
#3 lore raw
In reply to Miguel Ojeda
Quoted 9 lines · On Tue, 5 Jan 2021 06:58:15 +0100 Miguel Ojeda <[email protected]> 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.

Quoted 7 lines
Signed-off-by Miguel Ojeda <[email protected]>

---
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