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 v3 02/23] log: Fix incorrect documentation of log_filter.cat_list
Date: Sat, 17 Oct 2020 14:07:27 -0400	[thread overview]
Message-ID: <20201017180749.119271-3-seanga2@gmail.com> (raw)
In-Reply-To: <20201017180749.119271-1-seanga2@gmail.com>

Logging category lists are terminated by LOGC_END, not LOGC_NONE.

Fixes: e9c8d49d54 ("log: Add an implementation of logging")

Signed-off-by: Sean Anderson <seanga2@gmail.com>
Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
---

(no changes since v2)

Changes in v2:
- Also fix misdocumentation of for log_add_filter()

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

diff --git a/include/log.h b/include/log.h
index 4acc087b2e..3487c936c9 100644
--- a/include/log.h
+++ b/include/log.h
@@ -368,7 +368,7 @@ enum log_filter_flags {
  *	new filter, and must be provided when removing a previously added
  *	filter.
  * @flags: Flags for this filter (LOGFF_...)
- * @cat_list: List of categories to allow (terminated by LOGC_none). If empty
+ * @cat_list: List of categories to allow (terminated by %LOGC_END). If empty
  *	then all categories are permitted. Up to LOGF_MAX_CATEGORIES entries
  *	can be provided
  * @max_level: Maximum log level to allow
@@ -446,7 +446,7 @@ int do_log_test(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]);
  *
  * @drv_name: Driver name to add the filter to (since each driver only has a
  *	single device)
- * @cat_list: List of categories to allow (terminated by LOGC_none). If empty
+ * @cat_list: List of categories to allow (terminated by %LOGC_END). If empty
  *	then all categories are permitted. Up to LOGF_MAX_CATEGORIES entries
  *	can be provided
  * @max_level: Maximum log level to allow
-- 
2.28.0

  parent reply	other threads:[~2020-10-17 18:07 UTC|newest]

Thread overview: 37+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-10-17 18:07 [PATCH v3 00/23] log: Add commands for manipulating filters Sean Anderson
2020-10-17 18:07 ` [PATCH v3 01/23] log: Fix missing negation of ENOMEM Sean Anderson
2020-10-17 18:07 ` Sean Anderson [this message]
2020-10-17 18:07 ` [PATCH v3 03/23] log: Add additional const qualifier to arrays Sean Anderson
2020-10-17 18:07 ` [PATCH v3 04/23] log: Add new category names to log_cat_name Sean Anderson
2020-10-27 17:45   ` Tom Rini
2020-10-27 18:07     ` Sean Anderson
2020-10-27 18:08       ` Tom Rini
2020-10-17 18:07 ` [PATCH v3 05/23] log: Use CONFIG_IS_ENABLED() for LOG_TEST Sean Anderson
2020-10-17 18:07 ` [PATCH v3 06/23] log: Expose some helper functions Sean Anderson
2020-10-17 18:07 ` [PATCH v3 07/23] log: Add function to create a filter with flags Sean Anderson
2020-10-17 18:07 ` [PATCH v3 08/23] log: Add filter flag to deny on match Sean Anderson
2020-10-17 18:07 ` [PATCH v3 09/23] test: log: Convert log_test from python to C Sean Anderson
2020-11-03 15:11   ` Simon Glass
2020-10-17 18:07 ` [PATCH v3 10/23] test: log: Give tests names instead of numbers Sean Anderson
2020-11-03 15:11   ` Simon Glass
2020-10-17 18:07 ` [PATCH v3 11/23] test: Add tests for LOGFF_DENY Sean Anderson
2020-10-17 18:07 ` [PATCH v3 12/23] log: Add filter flag to match greater than a log level Sean Anderson
2020-10-17 18:07 ` [PATCH v3 13/23] test: Add test for LOGFF_MIN Sean Anderson
2020-10-17 18:07 ` [PATCH v3 14/23] cmd: log: Use sub-commands for log Sean Anderson
2020-10-17 18:07 ` [PATCH v3 15/23] cmd: log: Split off log level parsing Sean Anderson
2020-10-17 18:07 ` [PATCH v3 16/23] cmd: log: Add commands to list categories and drivers Sean Anderson
2020-10-17 18:07 ` [PATCH v3 17/23] cmd: log: Make "log level" print all log levels Sean Anderson
2020-10-17 18:07 ` [PATCH v3 18/23] lib: Add getopt Sean Anderson
2020-11-03 15:11   ` Simon Glass
2020-10-17 18:07 ` [PATCH v3 19/23] test: Add a test for getopt Sean Anderson
2020-11-03 15:11   ` Simon Glass
2020-10-17 18:07 ` [PATCH v3 20/23] cmd: log: Add commands to manipulate filters Sean Anderson
2020-10-17 18:07 ` [PATCH v3 21/23] test: Add a test for log filter-* Sean Anderson
2020-10-27 21:00   ` Tom Rini
2020-10-27 21:11     ` Sean Anderson
2020-10-27 21:12       ` Tom Rini
2020-10-17 18:07 ` [PATCH v3 22/23] doc: Add log kerneldocs to documentation Sean Anderson
2020-10-17 18:07 ` [PATCH v3 23/23] doc: Update logging documentation Sean Anderson
2020-10-27 20:58   ` Tom Rini
2020-10-27 21:00   ` Heinrich Schuchardt
2020-10-27 21:11     ` 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=20201017180749.119271-3-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