Welcome to little lamb

Code » limb » commit 424113b

Documentation tweaks/fixes

author Olivier Brunel
2023-05-29 17:34:37 UTC
committer Olivier Brunel
2023-07-05 07:39:26 UTC
parent 37bc6b8995593318864ffe324abad8013b958364

Documentation tweaks/fixes

src/doc/base.h/base_fmt.3.md +2 -2
src/doc/base32.h/base32_fmt.3.md +2 -2
src/doc/base64.h/base64_fmt.3.md +2 -2
src/doc/buffer-shldata.h/buffer_shldata_datasize.3.md +1 -0
src/doc/buffer-shldata.h/buffer_shldata_free.3.md +1 -0
src/doc/buffer-shldata.h/buffer_shldata_putinit.3.md +2 -1
src/doc/ccpl.h/ccpl_init.3.md +1 -1
src/doc/cdbmake.h.0.md +0 -1
src/doc/chacha20.h/chacha20_init.3.md +2 -2
src/doc/output.h.0.md +3 -2

diff --git a/src/doc/base.h/base_fmt.3.md b/src/doc/base.h/base_fmt.3.md
index e9df929..530b550 100644
--- a/src/doc/base.h/base_fmt.3.md
+++ b/src/doc/base.h/base_fmt.3.md
@@ -3,7 +3,7 @@
 
 # NAME
 
-base\_fmt, base\_scan - base-16/32/64/128 encode/decode a byte array
+base_fmt, base_scan - base-16/32/64/128 encode/decode a byte array
 
 # SYNOPSIS
 
@@ -53,7 +53,7 @@ only data validation is performed and the length required in `dst` is returned.
 ! and decoding as described in [RFC 4648][rfc4648], assuming corresponding
 ! alphabet is used (and `strict` is non-zero).
 
-[rfc4648] (https://datatracker.ietf.org/doc/html/rfc4648)
+[rfc4648]: https://datatracker.ietf.org/doc/html/rfc4648
 
 # RETURN VALUE
 
diff --git a/src/doc/base32.h/base32_fmt.3.md b/src/doc/base32.h/base32_fmt.3.md
index b3fed8d..47540e0 100644
--- a/src/doc/base32.h/base32_fmt.3.md
+++ b/src/doc/base32.h/base32_fmt.3.md
@@ -3,7 +3,7 @@
 
 # NAME
 
-base32\_fmt, base32\_scan - base32 encode/decode a byte array
+base32_fmt, base32_scan - base32 encode/decode a byte array
 
 # SYNOPSIS
 
@@ -30,7 +30,7 @@ accepts a single padding character to indicate padding.
 
 Refer to [base_scan](3) for more details.
 
-[rfc4648] (https://datatracker.ietf.org/doc/html/rfc4648)
+[rfc4648]: https://datatracker.ietf.org/doc/html/rfc4648
 
 # RETURN VALUE
 
diff --git a/src/doc/base64.h/base64_fmt.3.md b/src/doc/base64.h/base64_fmt.3.md
index 3ee1a3b..15b6328 100644
--- a/src/doc/base64.h/base64_fmt.3.md
+++ b/src/doc/base64.h/base64_fmt.3.md
@@ -3,7 +3,7 @@
 
 # NAME
 
-base64\_fmt, base64\_scan - base64 encode/decode a byte array
+base64_fmt, base64_scan - base64 encode/decode a byte array
 
 # SYNOPSIS
 
@@ -30,7 +30,7 @@ accepts a single padding character to indicate padding.
 
 Refer to [base_scan](3) for more details.
 
-[rfc4648] (https://datatracker.ietf.org/doc/html/rfc4648)
+[rfc4648]: https://datatracker.ietf.org/doc/html/rfc4648
 
 # RETURN VALUE
 
diff --git a/src/doc/buffer-shldata.h/buffer_shldata_datasize.3.md b/src/doc/buffer-shldata.h/buffer_shldata_datasize.3.md
new file mode 120000
index 0000000..b9cb1a2
--- /dev/null
+++ b/src/doc/buffer-shldata.h/buffer_shldata_datasize.3.md
@@ -0,0 +1 @@
+buffer_shldata_getinit.3.md
\ No newline at end of file
diff --git a/src/doc/buffer-shldata.h/buffer_shldata_free.3.md b/src/doc/buffer-shldata.h/buffer_shldata_free.3.md
new file mode 120000
index 0000000..6ea1313
--- /dev/null
+++ b/src/doc/buffer-shldata.h/buffer_shldata_free.3.md
@@ -0,0 +1 @@
+buffer_shldata_putinit.3.md
\ No newline at end of file
diff --git a/src/doc/buffer-shldata.h/buffer_shldata_putinit.3.md b/src/doc/buffer-shldata.h/buffer_shldata_putinit.3.md
index 667b424..1370228 100644
--- a/src/doc/buffer-shldata.h/buffer_shldata_putinit.3.md
+++ b/src/doc/buffer-shldata.h/buffer_shldata_putinit.3.md
@@ -4,7 +4,8 @@
 # NAME
 
 buffer\_shldata\_putinit, buffer\_shldata\_put, buffer\_shldata\_putfinal -
-encrypt data using the shielded data protocol through buffer interface
+buffer\_shldata\_free - encrypt data using the shielded data protocol through
+buffer interface
 
 # SYNOPSIS
 
diff --git a/src/doc/ccpl.h/ccpl_init.3.md b/src/doc/ccpl.h/ccpl_init.3.md
index a004d13..6b0f08a 100644
--- a/src/doc/ccpl.h/ccpl_init.3.md
+++ b/src/doc/ccpl.h/ccpl_init.3.md
@@ -37,7 +37,7 @@ however an additional limitation, specific to this combined algorithm, also
 applies, and brings the maximum size of both the additional data and the
 encrypted data to 2^64 bytes each.
 
-[rfc8439] (https://datatracker.ietf.org/doc/html/rfc8439)
+[rfc8439]: https://datatracker.ietf.org/doc/html/rfc8439
 
 First, the `ccpl_aad`() function must be used to feed additional data pointed by
 `data` of length `dlen` into the ccpl context pointed by `ctx`. Such data will
diff --git a/src/doc/cdbmake.h.0.md b/src/doc/cdbmake.h.0.md
index a3bd10d..20c8ef6 100644
--- a/src/doc/cdbmake.h.0.md
+++ b/src/doc/cdbmake.h.0.md
@@ -1,4 +1,3 @@
-
 % limb manual
 % cdbmake.h(0)
 
diff --git a/src/doc/chacha20.h/chacha20_init.3.md b/src/doc/chacha20.h/chacha20_init.3.md
index f75b4b9..2b1a09a 100644
--- a/src/doc/chacha20.h/chacha20_init.3.md
+++ b/src/doc/chacha20.h/chacha20_init.3.md
@@ -33,8 +33,8 @@ Bernstein, as long as the given nonce has its first 32bit/4 bytes set to zero.
 In the former case, the message length shall not be more than 2^38 bytes. In
 the later case, the message length shall not be more than 2^70 bytes.
 
-[rfc8439] (https://datatracker.ietf.org/doc/html/rfc8439)
-[chacha20] (https://cr.yp.to/chacha/chacha-20080128.pdf)
+[rfc8439]: https://datatracker.ietf.org/doc/html/rfc8439
+[chacha20]: https://cr.yp.to/chacha/chacha-20080128.pdf
 
 
 The `chacha20_crypt`() function processed the `mlen` bytes pointed to by `msg`,
diff --git a/src/doc/output.h.0.md b/src/doc/output.h.0.md
index 870d34b..f30eaf5 100644
--- a/src/doc/output.h.0.md
+++ b/src/doc/output.h.0.md
@@ -15,8 +15,9 @@ output.h - writing to stdout/stderr
 This header defines functions used to write messages/warnings to stdout or
 stderr.
 
-It actually relies on/makes use of [out_putmsg](3), [err_putmsg](3),
-[dbg_putmsg](3), [out_putmsgdie](3) and [err_putmsgdie](3).
+Most of the following are implemented as macros to [obuffer_putmsg](3), using
+either *obuffer_1* or *obuffer_2*. Messages can also end up written to other
+output buffers if they were attached. For more, refer to [obuffer.h](0).
 
 ## Functions