[PATCH v2 0/3] trace2 docs: note that BUG() sends an "error" event
- From
Ævar Arnfjörð Bjarmason <avarab@gmail.com>
- Date
- Apr 13, 2021, 09:08 UTC
- Message-ID
- <cover-0.3-00000000000-20210413T090603Z-avarab@gmail.com>
- In-Reply-To
- <cover-0.5-00000000000-20210328T022343Z-avarab@gmail.com>
A trivial update to the trace2 docs to fix an omission with "BUG()" not being listed alongside error(), die() etc.
v1 of this[1] added a non-fatal-but-logging bug() function, per the discussion on v1 that's now gone.
1. http://lore.kernel.org/git/cover-0.6-00000000000-20210328T025618Z-avarab@gmail.com
Ævar Arnfjörð Bjarmason (3): usage.c: don't copy/paste the same comment three times api docs: document BUG() in api-error-handling.txt api docs: document that BUG() emits a trace2 error event
Documentation/technical/api-error-handling.txt | 10 ++++++++-- Documentation/technical/api-trace2.txt | 2 +- usage.c | 17 +++++------------ 3 files changed, 14 insertions(+), 15 deletions(-)
Range-diff against v1:
1: a7b329c21cf ! 1: 2e4665b625b usage.c: don't copy/paste the same comment three times
@@ Metadata
## Commit message ##
usage.c: don't copy/paste the same comment three times
- In gee4512ed481 (trace2: create new combined trace facility,
+ In ee4512ed481 (trace2: create new combined trace facility,
2019-02-22) we started with two copies of this comment,
0ee10fd1296 (usage: add trace2 entry upon warning(), 2020-11-23) added
a third. Let's instead add an earlier comment that applies to all
2: 8c8b1dfd184 = 2: ce78c79c9ac api docs: document BUG() in api-error-handling.txt
3: f0e0d0daa6e = 3: 982f72345f1 api docs: document that BUG() emits a trace2 error event
4: 515d146cac8 < -: ----------- usage.c: add a non-fatal bug() function to go with BUG()-- 2.31.1.645.g989d83ea6a6