From: James Prestwood <prestwoj@gmail.com>
To: iwd@lists.linux.dev
Cc: James Prestwood <prestwoj@gmail.com>
Subject: [PATCH 5/7] doc: document use of l_log APIs
Date: Thu, 22 Feb 2024 07:24:49 -0800 [thread overview]
Message-ID: <20240222152451.1541682-5-prestwoj@gmail.com> (raw)
In-Reply-To: <20240222152451.1541682-1-prestwoj@gmail.com>
With the introduction of l_notice in IWD some guidelines need to be
set for l_info, l_warn, l_error, l_debug and l_notice.
---
doc/coding-style.txt | 15 +++++++++++++++
1 file changed, 15 insertions(+)
diff --git a/doc/coding-style.txt b/doc/coding-style.txt
index bf0535c5..882de026 100644
--- a/doc/coding-style.txt
+++ b/doc/coding-style.txt
@@ -317,6 +317,21 @@ Functions that are static should not be forward-declared. The only exception
to this rule is if a circular dependency condition exists, and the forward
declaration cannot be avoided.
+M18: Use appropriate logging levels
+===================================
+An appropriate log level should be used depending on the type of message
+being logged. Logging is done using the l_log APIs in ELL:
+
+l_error An unexpected condition ocurred. These are generally fatal to the
+ current connection/protocol that is running but not generally to IWD's
+ overall operation.
+l_warn An unexpected, but non-fatal condition ocurred
+l_notice Should not be used directly. This log level is reserved for special
+ event type notifications which is handled by iwd_notice().
+l_info Information that is expected during normal operation. l_info's use
+ should be very limited so non-debug logs are concise
+l_debug General debugging. These can be used relatively freely but should
+ provide some piece of useful information.
O1: Shorten the name
====================
--
2.34.1
next prev parent reply other threads:[~2024-02-22 15:25 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-02-22 15:24 [PATCH 1/7] auto-t: fix failed_roam_test to pass when run on its own James Prestwood
2024-02-22 15:24 ` [PATCH 2/7] auto-t: timestamp log files in test-runner James Prestwood
2024-02-22 15:24 ` [PATCH 3/7] main: add runtime flag for setting the logger James Prestwood
2024-02-22 16:16 ` Denis Kenzior
2024-02-22 15:24 ` [PATCH 4/7] iwd: add iwd_notice for special event/state type of logging James Prestwood
2024-02-22 15:24 ` James Prestwood [this message]
2024-02-22 15:24 ` [PATCH 6/7] station: use iwd_notice for state/event information James Prestwood
2024-02-22 15:24 ` [PATCH 7/7] netdev: add notice events for connection timeouts James Prestwood
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20240222152451.1541682-5-prestwoj@gmail.com \
--to=prestwoj@gmail.com \
--cc=iwd@lists.linux.dev \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox