]> git.ipfire.org Git - thirdparty/git.git/commit
api docs: document that BUG() emits a trace2 error event
authorÆvar Arnfjörð Bjarmason <avarab@gmail.com>
Tue, 13 Apr 2021 09:08:21 +0000 (11:08 +0200)
committerJunio C Hamano <gitster@pobox.com>
Tue, 13 Apr 2021 21:57:13 +0000 (14:57 -0700)
commitf6d25d7878901f0ec9b7a9c07c584911fc0da2ff
tree22e2b80dee86792494abf4db7503ec811393da1a
parent4bf0c6f38f8a3dda532ab7e4b9b32d6c4bb925ec
api docs: document that BUG() emits a trace2 error event

Correct documentation added in e544221d97a (trace2:
Documentation/technical/api-trace2.txt, 2019-02-22) to state that
calling BUG() also emits an "error" event. See ee4512ed481 (trace2:
create new combined trace facility, 2019-02-22) for the initial
implementation.

The BUG() function did not emit an event then however, that was only
changed later in 0a9dde4a04c (usage: trace2 BUG() invocations,
2021-02-05), that commit changed the code, but didn't update any of
the docs.

Let's also add a cross-reference from api-error-handling.txt.

Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/technical/api-error-handling.txt
Documentation/technical/api-trace2.txt