diff mbox series

[ovs-dev] lib/backtrace: Fix error in log_backtrace() documentation.

Message ID 20240105164145.38627-1-frode.nordahl@canonical.com
State Accepted
Delegated to: Ilya Maximets
Headers show
Series [ovs-dev] lib/backtrace: Fix error in log_backtrace() documentation. | expand

Checks

Context Check Description
ovsrobot/apply-robot success apply and check: success
ovsrobot/github-robot-_Build_and_Test success github build: passed
ovsrobot/intel-ovs-compilation success test: success

Commit Message

Frode Nordahl Jan. 5, 2024, 4:41 p.m. UTC
The documentation for log_backtrace() states the backtrace is
logged at DEBUG level, while in reality it is logged at ERROR
level.

Fixes: d0b99d38edab ("backtrace: Add log_backtrace()")
Signed-off-by: Frode Nordahl <frode.nordahl@canonical.com>
---
 lib/backtrace.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Mike Pattrick Jan. 8, 2024, 3:25 p.m. UTC | #1
On Fri, Jan 5, 2024 at 11:42 AM Frode Nordahl
<frode.nordahl@canonical.com> wrote:
>
> The documentation for log_backtrace() states the backtrace is
> logged at DEBUG level, while in reality it is logged at ERROR
> level.
>
> Fixes: d0b99d38edab ("backtrace: Add log_backtrace()")
> Signed-off-by: Frode Nordahl <frode.nordahl@canonical.com>

That looks correct to me.

Acked-by: Mike Pattrick <mkp@redhat.com>
Ilya Maximets Jan. 9, 2024, 12:12 p.m. UTC | #2
On 1/8/24 16:25, Mike Pattrick wrote:
> On Fri, Jan 5, 2024 at 11:42 AM Frode Nordahl
> <frode.nordahl@canonical.com> wrote:
>>
>> The documentation for log_backtrace() states the backtrace is
>> logged at DEBUG level, while in reality it is logged at ERROR
>> level.
>>
>> Fixes: d0b99d38edab ("backtrace: Add log_backtrace()")
>> Signed-off-by: Frode Nordahl <frode.nordahl@canonical.com>
> 
> That looks correct to me.
> 
> Acked-by: Mike Pattrick <mkp@redhat.com>

Thanks!  Applied and backported down to 2.17.

It wasn't really necessary to backport, but I was backporting
other patches, so took this one along.  I also removed the 'lib/'
from the subject, as it seems not necessary and doesn't look
great in the git log near the patches that do not have that.

Best regards, Ilya Maximets.
diff mbox series

Patch

diff --git a/lib/backtrace.h b/lib/backtrace.h
index 9ccafd6d4..a2506da5f 100644
--- a/lib/backtrace.h
+++ b/lib/backtrace.h
@@ -26,7 +26,7 @@ 
 #endif
 
 /* log_backtrace() will save the backtrace of a running program
- * into the log at the DEBUG level.
+ * into the log at the ERROR level.
  *
  * To use it, insert the following code to where backtrace is
  * desired: