Skip to content

Commit 4bf0c6f

Browse files
avargitster
authored andcommitted
api docs: document BUG() in api-error-handling.txt
When the BUG() function was added in d819374 (usage.c: add BUG() function, 2017-05-12) these docs added in 1f23cfe (doc: document error handling functions and conventions, 2014-12-03) were not updated. Let's do that. Signed-off-by: Ævar Arnfjörð Bjarmason <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent c00c738 commit 4bf0c6f

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

Documentation/technical/api-error-handling.txt

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
Error reporting in git
22
======================
33

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.
69

710
- `die` is for fatal application errors. It prints a message to
811
the user and exits with status 128.

0 commit comments

Comments
 (0)