Mercurial > molko
changeset 440:c9bd1ff1ebe1
man: start splitting manual pages
author | David Demelier <markand@malikania.fr> |
---|---|
date | Tue, 18 Oct 2022 09:04:02 +0200 |
parents | f794dbbb18d2 |
children | 31c1bbc33813 |
files | GNUmakefile man/mlk-err.3 man/mlk_err_string.3 |
diffstat | 3 files changed, 30 insertions(+), 14 deletions(-) [+] |
line wrap: on
line diff
--- a/GNUmakefile Mon Oct 17 14:22:38 2022 +0200 +++ b/GNUmakefile Tue Oct 18 09:04:02 2022 +0200 @@ -416,7 +416,8 @@ # {{{ manual pages MAN3 := man/mlk-alloc.3 \ - man/mlk-err.3 + man/mlk-err.3 \ + man/mlk_err_string.3 # }}}
--- a/man/mlk-err.3 Mon Oct 17 14:22:38 2022 +0200 +++ b/man/mlk-err.3 Tue Oct 18 09:04:02 2022 +0200 @@ -5,14 +5,12 @@ .Nm mlk-err .Nd error management in mlk library .Sh LIBRARY -.Lb libmlk-core +libmlk-core (-lmlk-core) .Sh SYNOPSIS .In mlk/core/err.h -.Ft "const char *" -.Fn mlk_err_string "int e" .Sh DESCRIPTION This manual page describes error codes that may occur within the molko -framework. All errors are defined with negative numbers the only exception +framework. All errors are defined with negative numbers, the only exception being .Er MLK_ERR_NONE which is equal to 0. @@ -34,15 +32,7 @@ codes it should also be took in account which in this case the function .Fn mlk_err_string may comes handy. -.Pp -The function -.Fn mlk_err_string -returns a constant string description of the error -.Ar e . .Sh SEE ALSO -.Xr mlk-panic 3 +.Xr mlk_err_string 3 .Sh AUTHORS -The -.Nm -library was written by .An David Demelier Aq Mt markand@malikania.fr .
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/man/mlk_err_string.3 Tue Oct 18 09:04:02 2022 +0200 @@ -0,0 +1,25 @@ +.Dd $Mdocdate$ +.Dt MLK_ERR_STRING 3 +.Os +.Sh NAME +.Nm mlk_err_string +.Nd return human readable error string +.Sh LIBRARY +libmlk-core (-lmlk-core) +.Sh SYNOPSIS +.In mlk/core/err.h +.Ft "const char *" +.Fn mlk_err_string "int e" +.Sh DESCRIPTION +The function +.Fn mlk_err_string +returns a constant string description of the error code +.Fa e . +.Pp +See the +.Xr mlk-err 3 +manual page for a list of error codes. +.Sh SEE ALSO +.Xr mlk-err 3 +.Sh AUTHORS +.An David Demelier Aq Mt markand@malikania.fr .