update readme and man

2 files changed, 81 insertions, 18 deletions

diff --git a/man/el_option.3 b/man/el_option.3
index 02e9012..63245d0 100644
--- a/man/el_option.3
+++ b/man/el_option.3
@@ -23,7 +23,7 @@ that can be configured.
 Value inside parenthesis determines argument types of variadic arguments
 .I ...
 .PP
-.BI "EL_LEVEL (" enum " " el_level "level)"
+.BI "EL_LEVEL (" enum " " el_level " level)"
 .RS
 .   B EL_LEVEL
 sets what the current logging level shall be.
@@ -85,10 +85,12 @@ Setting log level cannot fail
 .   RE
 .RE
 .PP
-.BI "EL_OUT (" enum " " el_output ")"
+.BI "EL_OUT (" enum " " el_output " outputs)"
 .RS
 .   B EL_OUT
-simply sets to what output(s) logs will be printed to with any of the printing
+simply sets to what
+.IR outputs .
+logs will be printed to with any of the printing
 function.
 User can enable as many outputs as he desires - it can be all inputs or even
 none (if one wants to surpress logging for some time).
@@ -98,7 +100,9 @@ operator (
 .   B |
 ).
 .   PP
-Currently following \fIoutputs\fR can be enabled.
+Currently following
+.I outputs
+can be enabled.
 .   PP
 .   B EL_OUT_STDERR
 .   RS
@@ -178,7 +182,7 @@ is not implemented on current system (support was not compiled into library)
 .   RE
 .RE
 .PP
-.BI "EL_COLORS (" int ")"
+.BI "EL_COLORS (" int " colors)"
 .RS
 If this is set to 1, output will be enriched with ANSI colors depending on the
 message severity.
@@ -196,9 +200,11 @@ Input argument is different than 1 or 0
 .   RE
 .RE
 .PP
-.BI "EL_TS (" enum " " el_option_timestamp ")"
+.BI "EL_TS (" enum " " el_option_timestamp " timestamp)"
 .RS
-Allows timestamp to be added to each log message. Possible values are:
+Allows timestamp to be added to each log message. Possible values for
+.I timestamp
+are:
 .   PP
 .   B EL_TS_OFF
 .   RS
@@ -231,9 +237,9 @@ Timestamp support was not compiled in and setting this options is disabled
 .   RE
 .RE
 .PP
-.BI "EL_TS_TM (" enum " " el_option_timestamp_timer ")"
+.BI "EL_TS_TM (" enum " " el_option_timestamp_timer " timer)"
 .RS
-Sets the clock source for the timestamp print.
+Sets the timer source for the timestamp print.
 .   PP
 .   B EL_TS_TM_CLOCK
 .   RS
@@ -297,12 +303,12 @@ Input argument is invalid
 .       PP
 .       B ENODEV
 .       RS
-Specified timer source was not compiled in and is no available
+Specified timer source was not compiled in and is not available
 .       RE
 .   RE
 .RE
 .PP
-.BI "EL_PRINT_LEVEL (" int ")"
+.BI "EL_PRINT_LEVEL (" int " print)"
 .RS
 If this is set to 1, each log will have log level information prefix in format
 "l/" where 'l' is first character of level message is printed with, for example:
@@ -335,7 +341,7 @@ Input argument is different than 1 or 0
 .   RE
 .RE
 .PP
-.BI "EL_FINFO (" int ")"
+.BI "EL_FINFO (" int " finfo)"
 .RS
 If set to 1, adds information about log location to each message in format
 [some_file.c:123]. Setting this to 0, will result in no file information at all
@@ -349,7 +355,9 @@ Input argument is different than 1 or 0
 .   RE
 .RE
 .PP
-.BI "EL_CUSTOM_PUTS (" int " "(*el_custom_puts)(const " " char " " *s) ")
+.B EL_CUSTOM_PUTS (
+.I int (*el_custom_puts)(const char *s)
+.B )
 .RS
 Sets function pointer for custom message print.
 Function will receive complete messsage to print, just as it would be printed to
@@ -359,9 +367,11 @@ It is still mandatory to enable custom printing with
 .   BR el_option (3)
 .RE
 .PP
-.BI "EL_FNAME (" const " " char " " * ")"
+.BI "EL_FNAME (" const " " char " " * "path)"
 .RS
-Sets the file name for the logs. Logs will be stored in this file. If file
+Sets the
+.I path
+for the logs. Logs will be stored in this file. If file
 rotation is enabled, a numer will be postfixed to each file. See
 .   B EL_FROTATE_NUMBER
 in this page for more details.
@@ -388,7 +398,7 @@ If function fails, file is not opened and any calls that logs to file will
 result in failure.
 .RE
 .PP
-.BI "EL_FROTATE_NUMBER (" long ")"
+.BI "EL_FROTATE_NUMBER (" long " number)"
 .RS
 If set to 0, file rotation will be disabled and logs will be printed into
 specified file without size limit.
@@ -430,9 +440,11 @@ Input parameter is less than 0
 .   RE
 .RE
 .PP
-.BI "EL_FROTATE_SIZE (" long ")"
+.BI "EL_FROTATE_SIZE (" long " size)"
 .RS
-This defines size at which files will be rotated.
+This defines
+.I size
+at which files will be rotated.
 If message being printed would overflow rotate size, current file will be closed
 and new one will be created, and current message will be stored in that new
 file.
diff --git a/readme.md b/readme.md
index c853e02..3495d73 100644
--- a/readme.md
+++ b/readme.md
@@ -47,6 +47,36 @@ work. Also there are some additional features for users with **C99** compiler.
 
 To run unit tests, you also need [librb](http://librb.kurwinet.pl)
 
+Test results
+============
+
+machine tests
+-------------
+
+* aarch64-builder-linux-gnu ![test-result-svg][a64lg]
+* armv5te926-builder-linux-gnueabihf ![test-result-svg][armv5]
+* armv6j1136-builder-linux-gnueabihf ![test-result-svg][armv6]
+* armv7a15-builder-linux-gnueabihf ![test-result-svg][armv7a15]
+* armv7a9-builder-linux-gnueabihf ![test-result-svg][armv7a9]
+* i686-builder-freebsd ![test-result-svg][x32fb]
+* i686-builder-linux-gnu ![test-result-svg][x32lg]
+* i686-builder-linux-musl ![test-result-svg][x32lm]
+* i686-builder-linux-uclibc ![test-result-svg][x32lu]
+* i686-builder-netbsd ![test-result-svg][x32nb]
+* i686-builder-openbsd ![test-result-svg][x32ob]
+* mips-builder-linux-gnu ![test-result-svg][m32lg]
+* x86_64-builder-linux-gnu ![test-result-svg][x64lg]
+* x86_64-builder-linux-musl ![test-result-svg][x64lm]
+* x86_64-builder-linux-uclibc ![test-result-svg][x64lu]
+* x86_64-builder-solaris ![test-result-svg][x64ss]
+
+sanitizers
+----------
+
+* -fsanitize=address ![test-result-svg][fsan]
+* -fsanitize=leak ![test-result-svg][fsleak]
+* -fsanitize=undefined ![test-result-svg][fsun]
+
 Compiling and installing
 ========================
 
@@ -101,3 +131,24 @@ See also
 * [librb](http://librb.kurwinet.pl) ring buffer used in unit tests
 * [git repository](http://git.kurwinet.pl/embedlog) to browse code online
 * [continous integration](http://ci.embedlog.kurwinet.pl) for project
+
+[a64lg]: http://ci.embedlog.kurwinet.pl/badges/aarch64-builder-linux-gnu-tests.svg
+[armv5]: http://ci.embedlog.kurwinet.pl/badges/armv5te926-builder-linux-gnueabihf-tests.svg
+[armv6]: http://ci.embedlog.kurwinet.pl/badges/armv6j1136-builder-linux-gnueabihf-tests.svg
+[armv7a15]: http://ci.embedlog.kurwinet.pl/badges/armv7a15-builder-linux-gnueabihf-tests.svg
+[armv7a9]: http://ci.embedlog.kurwinet.pl/badges/armv7a9-builder-linux-gnueabihf-tests.svg
+[x32fb]: http://ci.embedlog.kurwinet.pl/badges/i686-builder-freebsd-tests.svg
+[x32lg]: http://ci.embedlog.kurwinet.pl/badges/i686-builder-linux-gnu-tests.svg
+[x32lm]: http://ci.embedlog.kurwinet.pl/badges/i686-builder-linux-musl-tests.svg
+[x32lu]: http://ci.embedlog.kurwinet.pl/badges/i686-builder-linux-uclibc-tests.svg
+[x32nb]: http://ci.embedlog.kurwinet.pl/badges/i686-builder-netbsd-tests.svg
+[x32ob]: http://ci.embedlog.kurwinet.pl/badges/i686-builder-openbsd-tests.svg
+[m32lg]: http://ci.embedlog.kurwinet.pl/badges/mips-builder-linux-gnu-tests.svg
+[x64lg]: http://ci.embedlog.kurwinet.pl/badges/x86_64-builder-linux-gnu-tests.svg
+[x64lm]: http://ci.embedlog.kurwinet.pl/badges/x86_64-builder-linux-musl-tests.svg
+[x64lu]: http://ci.embedlog.kurwinet.pl/badges/x86_64-builder-linux-uclibc-tests.svg
+[x64ss]: http://ci.embedlog.kurwinet.pl/badges/x86_64-builder-solaris-tests.svg
+
+[fsan]: http://ci.embedlog.kurwinet.pl/badges/fsanitize-address.svg
+[fsleak]: http://ci.embedlog.kurwinet.pl/badges/fsanitize-leak.svg
+[fsun]: http://ci.embedlog.kurwinet.pl/badges/fsanitize-undefined.svg