diff options
| author | Ævar Arnfjörð Bjarmason <avarab@gmail.com> | 2021-04-13 09:08:20 (GMT) |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2021-04-13 21:56:58 (GMT) |
| commit | 4bf0c6f38f8a3dda532ab7e4b9b32d6c4bb925ec (patch) | |
| tree | 094aee7442405207450a44423ef3b6db4c598571 /Documentation/technical | |
| parent | c00c7382ddc1e3f2d773b14366023abf53ecce2c (diff) | |
| download | git-4bf0c6f38f8a3dda532ab7e4b9b32d6c4bb925ec.zip git-4bf0c6f38f8a3dda532ab7e4b9b32d6c4bb925ec.tar.gz git-4bf0c6f38f8a3dda532ab7e4b9b32d6c4bb925ec.tar.bz2 | |
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>
Diffstat (limited to 'Documentation/technical')
| -rw-r--r-- | Documentation/technical/api-error-handling.txt | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/Documentation/technical/api-error-handling.txt b/Documentation/technical/api-error-handling.txt index ceeedd4..71486ab 100644 --- a/Documentation/technical/api-error-handling.txt +++ b/Documentation/technical/api-error-handling.txt @@ -1,8 +1,11 @@ Error reporting in git ====================== -`die`, `usage`, `error`, and `warning` report errors of various -kinds. +`BUG`, `die`, `usage`, `error`, and `warning` report errors of +various kinds. + +- `BUG` is for failed internal assertions that should never happen, + i.e. a bug in git itself. - `die` is for fatal application errors. It prints a message to the user and exits with status 128. |