Welcome to little lamb

Code » limb » commit e244b3d

doc: Small tweaks/fixes

author Olivier Brunel
2023-03-26 08:58:21 UTC
committer Olivier Brunel
2023-03-26 14:03:03 UTC
parent 4d7aa65d71fd613bb0a53ceb722377cc252913ad

doc: Small tweaks/fixes

doc/buffer.h.0.md +7 -6
doc/die.3.md +7 -2
doc/warn.3.md +7 -2

diff --git a/doc/buffer.h.0.md b/doc/buffer.h.0.md
index 62512cb..fac22b9 100644
--- a/doc/buffer.h.0.md
+++ b/doc/buffer.h.0.md
@@ -24,14 +24,15 @@ The following constants are defined :
 : *PUTMSG_ESC*, *ESC*
 :: Can be used as special string given to [buffer_putmsg](3) to toggle escaping
 
-: *PUTMSG_SYS*
-:: Can be used as special string given to [buffer_putmsg](3) to add error
-:: description of `errno`
 
 : *PUTMSG_LFF*
 :: Can be used as special string given to [buffer_putmsg](3) to add a new line
 :: and flush the buffer
 
+: *PUTMSG_SYS*
+:: Can be used as special string given to [buffer_putmsg](3) to add error
+:: description of `errno`
+
 : *PUTMSG_UINT_NEXT*
 :: Can be used as special string given to [buffer_putmsg](3) to indicate that
 :: the next element should be treated as an unsigned integer, whose decimal
@@ -49,7 +50,7 @@ The following macros are defined :
 :: [buffer_putmsg](3), following *PUTMSG_UINT_NEXT*, in order to have its
 :: decimal representation written into the buffer
 
-: *PUTMSG_ASINT(n)*
+: *PUTMSG_ASINT(`n`)*
 :: Same as *PUTMSG_ASUINT(`n`)* but with a signed integer (following
 :: *PUTMSG_INT_NEXT*)
 
@@ -58,8 +59,8 @@ The following macros are defined :
 :: for use in a coma-separated list, as it expands to:
 :: `PUTMSG_UINT_NEXT, PUTMSG_ASUINT(n)`
 
-: *PUTMSG_INT(n)*
-:: Same as *PUTMSG_UINT(n)* only for a signed integer
+: *PUTMSG_INT(`n`)*
+:: Same as *PUTMSG_UINT(`n`)* only for a signed integer
 
 ## Functions
 
diff --git a/doc/die.3.md b/doc/die.3.md
index 2e4c689..2bf5740 100644
--- a/doc/die.3.md
+++ b/doc/die.3.md
@@ -30,8 +30,9 @@ void dieversion(<em>version</em>, <em>year1</em>, <em>year2</em>, <em>author</em
 
 All of those are implemented as macros (to [err_putmsgdie](3) or
 [out_putmsgdie](3) for `dieversion`()) and will write the specified strings to
-*stderr* (or *stdout* for `dieversion`(), with a new line added at the end, then
-terminate the calling process via [\_exit](3) using `exit` as return/status code.
+*stderr* (or *stdout* for `dieversion`()), with a new line added at the end,
+then terminate the calling process via [\_exit](3) using `exit` as return/status
+code.
 
 ! INFO: output buffers
 ! All of those are using output buffers, and will therefore write to the output
@@ -49,6 +50,10 @@ The `diesys`(), `diefsys`() and `diefusys`() macros are similar, only the
 specified strings will be followed by a colon, a space and the error description
 provided by [strerror](3) according to `errno`.
 
+! HINT:
+! Some special features are supported, to e.g. easily include a number or
+! perform escaping of some strings. Refer to [out](3), or directly
+! [buffer_putmsg](3), for more.
 
 The `dieusage`() macro writes the word "usage: " followed by the program's name
 and a space as prefix, then the `usage` string.
diff --git a/doc/warn.3.md b/doc/warn.3.md
index f79ae6f..0e87b21 100644
--- a/doc/warn.3.md
+++ b/doc/warn.3.md
@@ -27,8 +27,8 @@ new line added at the end.
 
 ! INFO: output buffers
 ! All of those are using output buffers, and will therefore write to the output
-! buffers for *stdout* or *stderr*, as well as all the extra buffers set up,
-! e.g. via [obuffers_addlog](3) and/or [obuffers_adddbg](3).
+! buffers for *stderr*, as well as all the extra buffers set up, e.g. via
+! [obuffers_addlog](3) and/or [obuffers_adddbg](3).
 
 All warnings will be prefixed by the program's name (i.e. value of `PROG`), the
 word "warning " in between colon and a space.
@@ -39,6 +39,11 @@ The `warnsys`() and `warnusys`() macros are similar, only the specified strings
 will be followed by a colon, a space and the error description provided by
 [strerror](3) according to `errno`.
 
+! HINT:
+! Some special features are supported, to e.g. easily include a number or
+! perform escaping of some strings. Refer to [out](3), or directly
+! [buffer_putmsg](3), for more.
+
 # SEE ALSO
 
 [out](3), [err_putmsg](3), [buffer_putmsg](3)