diff mbox series

doc: log: correct option name CONFIG_LOG_MAX_LEVEL

Message ID 20200526094802.10927-1-patrick.delaunay@st.com
State Superseded
Headers show
Series doc: log: correct option name CONFIG_LOG_MAX_LEVEL | expand

Commit Message

Patrick Delaunay May 26, 2020, 9:48 a.m. UTC
Replace CONFIG_(SPL_)MAX_LOG_LEVEL by the correct name as defined in
common/Kconfig:
line 668:config LOG_MAX_LEVEL
line 688:config SPL_LOG_MAX_LEVEL
line 708:config TPL_LOG_MAX_LEVEL

Signed-off-by: Patrick Delaunay <patrick.delaunay at st.com>
---

 doc/README.log | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Heinrich Schuchardt May 26, 2020, 1:51 p.m. UTC | #1
On 26.05.20 11:48, Patrick Delaunay wrote:
> Replace CONFIG_(SPL_)MAX_LOG_LEVEL by the correct name as defined in
> common/Kconfig:
> line 668:config LOG_MAX_LEVEL
> line 688:config SPL_LOG_MAX_LEVEL
> line 708:config TPL_LOG_MAX_LEVEL
>
> Signed-off-by: Patrick Delaunay <patrick.delaunay at st.com>

> ---
>
>  doc/README.log | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/doc/README.log b/doc/README.log
> index 1057981f45..170e4ba24e 100644
> --- a/doc/README.log
> +++ b/doc/README.log
> @@ -60,13 +60,13 @@ Enabling logging
>  The following options are used to enable logging at compile time:
>
>     CONFIG_LOG		- Enables the logging system
> -   CONFIG_MAX_LOG_LEVEL - Max log level to build (anything higher is compiled
> +   CONFIG_LOG_MAX_LEVEL - Max log level to build (anything higher is compiled
>  				out)
>     CONFIG_LOG_CONSOLE	- Enable writing log records to the console
>
>  If CONFIG_LOG is not set, then no logging will be available.
>
> -The above have SPL versions also, e.g. CONFIG_SPL_MAX_LOG_LEVEL.
> +The above have SPL versions also, e.g. CONFIG_SPL_LOG_MAX_LEVEL.

Please mention TPL and CONFIG_TPL_LOG_MAX_LEVEL here too.

@Simon:
It would be good to reformat the whole file as restructured text and add
it to the HTML documentation.

Best regards

Heinrich

>
>
>  Temporary logging within a single file
>
Patrick Delaunay May 26, 2020, 4:27 p.m. UTC | #2
Hi,

> From: Heinrich Schuchardt <xypron.glpk at gmx.de>
> Sent: mardi 26 mai 2020 15:51
> 
> On 26.05.20 11:48, Patrick Delaunay wrote:
> > Replace CONFIG_(SPL_)MAX_LOG_LEVEL by the correct name as defined in
> > common/Kconfig:
> > line 668:config LOG_MAX_LEVEL
> > line 688:config SPL_LOG_MAX_LEVEL
> > line 708:config TPL_LOG_MAX_LEVEL
> >
> > Signed-off-by: Patrick Delaunay <patrick.delaunay at st.com>
> 
> > ---
> >
> >  doc/README.log | 4 ++--
> >  1 file changed, 2 insertions(+), 2 deletions(-)
> >
> > diff --git a/doc/README.log b/doc/README.log index
> > 1057981f45..170e4ba24e 100644
> > --- a/doc/README.log
> > +++ b/doc/README.log
[...]
> >
> > -The above have SPL versions also, e.g. CONFIG_SPL_MAX_LOG_LEVEL.
> > +The above have SPL versions also, e.g. CONFIG_SPL_LOG_MAX_LEVEL.
> 
> Please mention TPL and CONFIG_TPL_LOG_MAX_LEVEL here too.

Yes, I prepare a V2.

Regards.

Patrick
diff mbox series

Patch

diff --git a/doc/README.log b/doc/README.log
index 1057981f45..170e4ba24e 100644
--- a/doc/README.log
+++ b/doc/README.log
@@ -60,13 +60,13 @@  Enabling logging
 The following options are used to enable logging at compile time:
 
    CONFIG_LOG		- Enables the logging system
-   CONFIG_MAX_LOG_LEVEL - Max log level to build (anything higher is compiled
+   CONFIG_LOG_MAX_LEVEL - Max log level to build (anything higher is compiled
 				out)
    CONFIG_LOG_CONSOLE	- Enable writing log records to the console
 
 If CONFIG_LOG is not set, then no logging will be available.
 
-The above have SPL versions also, e.g. CONFIG_SPL_MAX_LOG_LEVEL.
+The above have SPL versions also, e.g. CONFIG_SPL_LOG_MAX_LEVEL.
 
 
 Temporary logging within a single file