Kernel/iwd
3
0
Fork 0
mirror of https://git.kernel.org/pub/scm/network/wireless/iwd.git synced 2024-11-22 06:29:23 +01:00
Code Releases Activity

doc: document use of l_log APIs

Browse Source 
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.
This commit is contained in:
James Prestwood 2024-02-22 07:24:49 -08:00 committed by Denis Kenzior
parent d8a6fb86c1
commit 98ae3d4197
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
doc/coding-style.txt
View File

@ -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 to this rule is if a circular dependency condition exists, and the forward
declaration cannot be avoided. 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 O1: Shorten the name
==================== ====================