Skip to content

Document error handling #1926

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
eriksjolund wants to merge 1 commit into
base: main
Choose a base branch
from
+18 −0
Open

Document error handling #1926

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions design-docs/error_handling.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
The C source code under the directory `src/` follows this convention regarding error handling:

Functions that can return a failure to the caller, take the argument
`libcrun_error_t *err` and return an int or a pointer.

If the function succeeds, then

- `0` or a non-NULL pointer is returned.
- `err` is not modified.

If the function fails, then

- a negative number or a non-NULL pointer is returned.
- `err` is set to the pointer of an allocated `struct libcrun_error_s`.
The member `status` is set to an errno-style value.
The member `msg` is set to an allocated error message string.

The functions expect that the passed in `err` is not already pointing to an allocated `struct libcrun_error_s`.