Gecko [ tanishkshah.com ]

Name	Size	Permission	Date
api-error-handling.adoc	3.73 KB	-rw-r--r--	2025-11-17 16:38
api-error-handling.html	35.21 KB	-rw-r--r--	2026-04-05 23:58
api-index-skel.adoc	432 B	-rw-r--r--	2025-11-17 16:38
api-index.adoc	689 B	-rw-r--r--	2026-04-05 23:58
api-index.html	30.43 KB	-rw-r--r--	2026-04-05 23:59
api-index.sh	714 B	-rw-r--r--	2025-11-17 16:38
api-merge.adoc	1.06 KB	-rw-r--r--	2025-11-17 16:38
api-merge.html	31.51 KB	-rw-r--r--	2026-04-05 23:58
api-parse-options.adoc	13.01 KB	-rw-r--r--	2025-11-17 16:38
api-parse-options.html	49.44 KB	-rw-r--r--	2026-04-05 23:58
api-path-walk.adoc	3.27 KB	-rw-r--r--	2025-11-17 16:38
api-path-walk.html	34.28 KB	-rw-r--r--	2026-04-05 23:58
api-simple-ipc.adoc	4.74 KB	-rw-r--r--	2025-11-17 16:38
api-simple-ipc.html	35.49 KB	-rw-r--r--	2026-04-05 23:58
api-trace2.adoc	43.45 KB	-rw-r--r--	2025-11-17 16:38
api-trace2.html	86.12 KB	-rw-r--r--	2026-04-05 23:58
bitmap-format.adoc	14.66 KB	-rw-r--r--	2025-11-17 16:38
bitmap-format.html	49.31 KB	-rw-r--r--	2026-04-05 23:58
build-systems.adoc	7.96 KB	-rw-r--r--	2025-11-17 16:38
build-systems.html	41.02 KB	-rw-r--r--	2026-04-05 23:58
bundle-uri.adoc	26.12 KB	-rw-r--r--	2025-11-17 16:38
bundle-uri.html	63.08 KB	-rw-r--r--	2026-04-05 23:58
commit-graph.adoc	17.7 KB	-rw-r--r--	2025-11-17 16:38
commit-graph.html	52.61 KB	-rw-r--r--	2026-04-05 23:58
directory-rename-detection.adoc	5.08 KB	-rw-r--r--	2025-11-17 16:38
directory-rename-detection.html	36.33 KB	-rw-r--r--	2026-04-05 23:58
hash-function-transition.adoc	35.45 KB	-rw-r--r--	2025-11-17 16:38
hash-function-transition.html	75.42 KB	-rw-r--r--	2026-04-05 23:58
large-object-promisors.adoc	26.59 KB	-rw-r--r--	2025-11-17 16:38
large-object-promisors.html	62.72 KB	-rw-r--r--	2026-04-05 23:58
long-running-process-protocol.adoc	1.88 KB	-rw-r--r--	2025-11-17 16:38
long-running-process-protocol.html	32.18 KB	-rw-r--r--	2026-04-05 23:58
meson.build	1.49 KB	-rw-r--r--	2025-11-17 16:38
multi-pack-index.adoc	11.31 KB	-rw-r--r--	2025-11-17 16:38
multi-pack-index.html	44.62 KB	-rw-r--r--	2026-04-05 23:58
pack-heuristics.adoc	17.62 KB	-rw-r--r--	2025-11-17 16:38
pack-heuristics.html	54.83 KB	-rw-r--r--	2026-04-05 23:58
packfile-uri.adoc	3.66 KB	-rw-r--r--	2025-11-17 16:38
packfile-uri.html	34.64 KB	-rw-r--r--	2026-04-05 23:58
parallel-checkout.adoc	12.01 KB	-rw-r--r--	2025-11-17 16:38
parallel-checkout.html	44.27 KB	-rw-r--r--	2026-04-05 23:58
partial-clone.adoc	14.59 KB	-rw-r--r--	2025-11-17 16:38
partial-clone.html	48.96 KB	-rw-r--r--	2026-04-05 23:58
platform-support.adoc	8.95 KB	-rw-r--r--	2025-11-17 16:38
platform-support.html	40.71 KB	-rw-r--r--	2026-04-05 23:58
racy-git.adoc	8.91 KB	-rw-r--r--	2025-11-17 16:38
racy-git.html	41.04 KB	-rw-r--r--	2026-04-05 23:58
reftable.adoc	36.65 KB	-rw-r--r--	2025-11-17 16:38
reftable.html	86.46 KB	-rw-r--r--	2026-04-05 23:58
remembering-renames.adoc	29.71 KB	-rw-r--r--	2025-11-17 16:38
remembering-renames.html	65.78 KB	-rw-r--r--	2026-04-05 23:58
repository-version.adoc	3.19 KB	-rw-r--r--	2025-11-17 16:38
repository-version.html	33.92 KB	-rw-r--r--	2026-04-05 23:58
rerere.adoc	6.36 KB	-rw-r--r--	2025-11-17 16:38
rerere.html	38.33 KB	-rw-r--r--	2026-04-05 23:58
scalar.adoc	2.87 KB	-rw-r--r--	2025-11-17 16:38
scalar.html	33.61 KB	-rw-r--r--	2026-04-05 23:58
send-pack-pipeline.adoc	1.92 KB	-rw-r--r--	2025-11-17 16:38
send-pack-pipeline.html	32.41 KB	-rw-r--r--	2026-04-05 23:58
shallow.adoc	2.49 KB	-rw-r--r--	2025-11-17 16:38
shallow.html	32.77 KB	-rw-r--r--	2026-04-05 23:58
sparse-checkout.adoc	46.68 KB	-rw-r--r--	2025-11-17 16:38
sparse-checkout.html	92.36 KB	-rw-r--r--	2026-04-05 23:58
sparse-index.adoc	9.28 KB	-rw-r--r--	2025-11-17 16:38
sparse-index.html	41.79 KB	-rw-r--r--	2026-04-05 23:58
trivial-merge.adoc	4.16 KB	-rw-r--r--	2025-11-17 16:38
trivial-merge.html	35.33 KB	-rw-r--r--	2026-04-05 23:58
unit-tests.adoc	9.8 KB	-rw-r--r--	2025-11-17 16:38
unit-tests.html	50.73 KB	-rw-r--r--	2026-04-05 23:58

Rename

Error reporting in git
======================

`BUG`, `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.

- `bug` (lower-case, not `BUG`) is supposed to be used like `BUG` but
  prints a "BUG" message instead of calling `abort()`.
+
A call to `bug()` will then result in a "real" call to the `BUG()`
function, either explicitly by invoking `BUG_if_bug()` after call(s)
to `bug()`, or implicitly at `exit()` time where we'll check if we
encountered any outstanding `bug()` invocations.
+
If there were no prior calls to `bug()` before invoking `BUG_if_bug()`
the latter is a NOOP. The `BUG_if_bug()` function takes the same
arguments as `BUG()` itself. Calling `BUG_if_bug()` explicitly isn't
necessary, but ensures that we die as soon as possible.
+
If you know you had prior calls to `bug()` then calling `BUG()` itself
is equivalent to calling `BUG_if_bug()`, the latter being a wrapper
calling `BUG()` if we've set a flag indicating that we've called
`bug()`.
+
This is for the convenience of APIs who'd like to potentially report
more than one "bug", such as the optbug() validation in
parse-options.c.

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

- `usage` is for errors in command line usage.  After printing its
  message, it exits with status 129.  (See also `usage_with_options`
  in the link:api-parse-options.html[parse-options API].)

- `error` is for non-fatal library errors.  It prints a message
  to the user and returns -1 for convenience in signaling the error
  to the caller.

- `warning` is for reporting situations that probably should not
  occur but which the user (and Git) can continue to work around
  without running into too many problems.  Like `error`, it
  returns -1 after reporting the situation to the caller.

These reports will be logged via the trace2 facility. See the "error"
event in link:api-trace2.html[trace2 API].

Customizable error handlers
---------------------------

The default behavior of `die` and `error` is to write a message to
stderr and then exit or return as appropriate.  This behavior can be
overridden using `set_die_routine` and `set_error_routine`.  For
example, "git daemon" uses set_die_routine to write the reason `die`
was called to syslog before exiting.

Library errors
--------------

Functions return a negative integer on error.  Details beyond that
vary from function to function:

- Some functions return -1 for all errors.  Others return a more
  specific value depending on how the caller might want to react
  to the error.

- Some functions report the error to stderr with `error`,
  while others leave that for the caller to do.

- errno is not meaningful on return from most functions (except
  for thin wrappers for system calls).

Check the function's API documentation to be sure.

Caller-handled errors
---------------------

An increasing number of functions take a parameter 'struct strbuf *err'.
On error, such functions append a message about what went wrong to the
'err' strbuf.  The message is meant to be complete enough to be passed
to `die` or `error` as-is.  For example:

if (ref_transaction_commit(transaction, &err))
		die("%s", err.buf);

The 'err' parameter will be untouched if no error occurred, so multiple
function calls can be chained:

t = ref_transaction_begin(&err);
	if (!t ||
	    ref_transaction_update(t, "HEAD", ..., &err) ||
	    ret_transaction_commit(t, &err))
		die("%s", err.buf);

The 'err' parameter must be a pointer to a valid strbuf.  To silence
a message, pass a strbuf that is explicitly ignored:

if (thing_that_can_fail_in_an_ignorable_way(..., &err))
		/* This failure is okay. */
		strbuf_reset(&err);