public inbox for u-boot@lists.denx.de
 help / color / mirror / Atom feed
From: Sean Anderson <seanga2@gmail.com>
To: u-boot@lists.denx.de
Subject: [PATCH 18/18] doc: Update logging documentation
Date: Tue,  6 Oct 2020 15:16:10 -0400	[thread overview]
Message-ID: <20201006191610.761899-19-seanga2@gmail.com> (raw)
In-Reply-To: <20201006191610.761899-1-seanga2@gmail.com>

This updates logging documentation with some examples of the new commands
added in the previous commits. It also removes some items from the to-do
list which have been implemented.

Signed-off-by: Sean Anderson <seanga2@gmail.com>
---

 doc/develop/logging.rst | 42 +++++++++++++++++++++++++++++------------
 1 file changed, 30 insertions(+), 12 deletions(-)

diff --git a/doc/develop/logging.rst b/doc/develop/logging.rst
index 6a22062073..8b6237f829 100644
--- a/doc/develop/logging.rst
+++ b/doc/develop/logging.rst
@@ -174,18 +174,45 @@ fields are present, but not the field order.
 Filters
 -------
 
-Filters are attached to log drivers to control what those drivers emit. Only
-records that pass through the filter make it to the driver.
+Filters are attached to log drivers to control what those drivers emit. FIlters
+can either allow or deny a log message when they match it. Only records which
+are allowed by a filter make it to the driver.
 
 Filters can be based on several criteria:
 
-* maximum log level
+* minimum or maximum log level
 * in a set of categories
 * in a set of files
 
 If no filters are attached to a driver then a default filter is used, which
 limits output to records with a level less than CONFIG_MAX_LOG_LEVEL.
 
+Adding Filters
+~~~~~~~~~~~~~~
+
+To add new filters at runtime, use the 'log filter-add' command. For example, to
+filter messages from the SPI subsystem, run::
+
+    log filter-add -D -c spi
+
+You will also need to allow everything else to emit messages (because the
+default filter no longer applies)::
+
+    log filter-add -A -l debug
+
+To view active filters, use the 'log filter-list' command. Some example output
+is::
+
+    => log filter-list
+    num policy level           categories files
+      0   deny <=IO                   spi
+      1  allow <=DEBUG
+
+Note that filters are processed in-order from top to bottom, not in the order of
+their filter number. Filters are added to the top of the list if they deny when
+they match, and to the bottom if they allow when they match. For more
+information, consult the usage of the 'log' command, by running 'help log'.
+
 
 Logging statements
 ------------------
@@ -259,8 +286,6 @@ Add a way to browse log records
 
 Add a way to record log records for browsing using an external tool
 
-Add commands to add and remove filters
-
 Add commands to add and remove log devices
 
 Allow sharing of printf format strings in log records to reduce storage size
@@ -268,10 +293,6 @@ for large numbers of log records
 
 Add a command-line option to sandbox to set the default logging level
 
-Convert core driver model code to use logging
-
-Convert uclasses to use logging with the correct category
-
 Consider making log() calls emit an automatic newline, perhaps with a logn()
 function to avoid that
 
@@ -282,9 +303,6 @@ number dropped due to them being generated before the log system was ready.
 
 Add a printf() format string pragma so that log statements are checked properly
 
-Enhance the log console driver to show level / category / file / line
-information
-
 Add a command to add new log records and delete existing records.
 
 Provide additional log() functions - e.g. logc() to specify the category
-- 
2.28.0

  parent reply	other threads:[~2020-10-06 19:16 UTC|newest]

Thread overview: 32+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-10-06 19:15 [PATCH 00/18] log: Add commands for manipulating filters Sean Anderson
2020-10-06 19:15 ` [PATCH 01/18] log: Fix missing negation of ENOMEM Sean Anderson
2020-10-06 20:36   ` Heinrich Schuchardt
2020-10-06 19:15 ` [PATCH 02/18] log: Fix incorrect documentation of log_filter.cat_list Sean Anderson
2020-10-06 20:41   ` Heinrich Schuchardt
2020-10-06 19:15 ` [PATCH 03/18] log: Add new category names to log_cat_name Sean Anderson
2020-10-06 20:45   ` Heinrich Schuchardt
2020-10-06 19:15 ` [PATCH 04/18] log: Use CONFIG_IS_ENABLED() for LOG_TEST Sean Anderson
2020-10-06 19:15 ` [PATCH 05/18] log: Expose log_device_find_by_name Sean Anderson
2020-10-06 19:15 ` [PATCH 06/18] log: Add function to create a filter with flags Sean Anderson
2020-10-06 19:15 ` [PATCH 07/18] log: Add filter flag to deny on match Sean Anderson
2020-10-06 19:16 ` [PATCH 08/18] test: Add tests for LOGFF_DENY Sean Anderson
2020-10-06 19:16 ` [PATCH 09/18] log: Add filter flag to match greater than a log level Sean Anderson
2020-10-06 19:16 ` [PATCH 10/18] test: Add test for LOGFF_MIN Sean Anderson
2020-10-06 19:16 ` [PATCH 11/18] cmd: log: Use sub-commands for log Sean Anderson
2020-10-06 19:16 ` [PATCH 12/18] cmd: log: Split off log level parsing Sean Anderson
2020-10-06 19:16 ` [PATCH 13/18] lib: Add getopt Sean Anderson
2020-10-06 19:16 ` [PATCH 14/18] test: Add a test for getopt Sean Anderson
2020-10-06 19:16 ` [PATCH 15/18] cmd: log: Add commands to manipulate filters Sean Anderson
2020-10-06 21:14   ` Heinrich Schuchardt
2020-10-06 21:51     ` Sean Anderson
2020-10-06 22:02   ` Simon Glass
2020-10-06 22:04     ` Sean Anderson
2020-10-06 19:16 ` [PATCH 16/18] test: py: Add a test for log filter-* Sean Anderson
2020-10-06 22:07   ` Simon Glass
2020-10-06 22:09     ` Sean Anderson
2020-10-06 19:16 ` [PATCH 17/18] doc: Add log kerneldocs to documentation Sean Anderson
2020-10-06 19:16 ` Sean Anderson [this message]
2020-10-06 20:34   ` [PATCH 18/18] doc: Update logging documentation Heinrich Schuchardt
2020-10-06 20:38     ` Sean Anderson
2020-10-06 21:28       ` Heinrich Schuchardt
2020-10-06 22:00         ` Sean Anderson

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=20201006191610.761899-19-seanga2@gmail.com \
    --to=seanga2@gmail.com \
    --cc=u-boot@lists.denx.de \
    /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