Mercurial > molko

annotate man/mlk-err.3 @ 475:1a1265445157

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
core: forgot panic_handler
author David Demelier <markand@malikania.fr>
date Mon, 27 Feb 2023 12:44:13 +0100
parents c9bd1ff1ebe1
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
437
e1eebc6bf25d man: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 .Dd $Mdocdate$
e1eebc6bf25d man: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 .Dt MLK-ERR 3
e1eebc6bf25d man: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 .Os
e1eebc6bf25d man: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 .Sh NAME
e1eebc6bf25d man: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 .Nm mlk-err
e1eebc6bf25d man: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 .Nd error management in mlk library
e1eebc6bf25d man: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 .Sh LIBRARY
440
c9bd1ff1ebe1 man: start splitting manual pages
David Demelier <markand@malikania.fr>
parents: 437
diff changeset
8 libmlk-core (-lmlk-core)
437
e1eebc6bf25d man: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 .Sh SYNOPSIS
e1eebc6bf25d man: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 .In mlk/core/err.h
e1eebc6bf25d man: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 .Sh DESCRIPTION
e1eebc6bf25d man: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 This manual page describes error codes that may occur within the molko
440
c9bd1ff1ebe1 man: start splitting manual pages
David Demelier <markand@malikania.fr>
parents: 437
diff changeset
13 framework. All errors are defined with negative numbers, the only exception
437
e1eebc6bf25d man: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 being
e1eebc6bf25d man: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 .Er MLK_ERR_NONE
e1eebc6bf25d man: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 which is equal to 0.
e1eebc6bf25d man: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 .Pp
e1eebc6bf25d man: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
18 The following macro constants are defined:
e1eebc6bf25d man: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 .Bl -tag -width Ds
e1eebc6bf25d man: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 .It Er MLK_ERR_NONE
e1eebc6bf25d man: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
21 Equal to 0, no error.
e1eebc6bf25d man: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 .It Er MLK_ERR_NO_MEM
e1eebc6bf25d man: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 No more memory available.
e1eebc6bf25d man: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 .It Er MLK_ERR_NO_SUPPORT
e1eebc6bf25d man: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 The file format or function is not supported.
e1eebc6bf25d man: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 .It Er MLK_ERR_FORMAT
e1eebc6bf25d man: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 The file is corrupt or invalid.
e1eebc6bf25d man: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 .El
e1eebc6bf25d man: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 .Pp
e1eebc6bf25d man: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 There are other private error codes that are internal to the framework and not
e1eebc6bf25d man: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
31 listed as they may change over time, if the caller inspects individual error
e1eebc6bf25d man: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 codes it should also be took in account which in this case the function
e1eebc6bf25d man: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 .Fn mlk_err_string
e1eebc6bf25d man: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 may comes handy.
e1eebc6bf25d man: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 .Sh SEE ALSO
440
c9bd1ff1ebe1 man: start splitting manual pages
David Demelier <markand@malikania.fr>
parents: 437
diff changeset
36 .Xr mlk_err_string 3
437
e1eebc6bf25d man: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 .Sh AUTHORS
e1eebc6bf25d man: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
38 .An David Demelier Aq Mt markand@malikania.fr .