api docs: document BUG() in api-error-handling.txt
When the BUG() function was added in d8193743e08 (usage.c: add BUG() function, 2017-05-12) these docs added in 1f23cfe0ef5 (doc: document error handling functions and conventions, 2014-12-03) were not updated. Let's do that. Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Ævar Arnfjörð Bjarmason committed
Apr 13, 2021 at 11:08 UTC
4bf0c6f38f8a3dda532ab7e4b9b32d6c4bb925ec
1 file changed
+5
-2
Documentation/technical/api-error-handling.txt
+5
-2
@@ -1,8 +1,11 @@
1
Error reporting in git
2
======================
3
4
-`die`, `usage`, `error`, and `warning` report errors of various
5
-kinds.
4
+`BUG`, `die`, `usage`, `error`, and `warning` report errors of
5
+various kinds.
6
+
7
+- `BUG` is for failed internal assertions that should never happen,
8
+ i.e. a bug in git itself.
9
10
- `die` is for fatal application errors. It prints a message to
11
the user and exits with status 128.