Welcome to little lamb

Code » limb » commit e0999f3

doc: Minor tweaks/fixes

author Olivier Brunel
2023-10-02 10:44:37 UTC
committer Olivier Brunel
2024-01-01 19:10:12 UTC
parent 80fd5d4923ebac5c72d0371aedd98677892a48b5

doc: Minor tweaks/fixes

src/doc/esc.h/escall_fmt.3.md +2 -2
src/doc/pbkdf2.h/pbkdf2.3.md +1 -1
src/doc/posixplz.h/mkfiletemp.3.md +1 -1
src/doc/shldata.h/shldata_initr.3.md +1 -1

diff --git a/src/doc/esc.h/escall_fmt.3.md b/src/doc/esc.h/escall_fmt.3.md
index 29a20e5..a69c5b4 100644
--- a/src/doc/esc.h/escall_fmt.3.md
+++ b/src/doc/esc.h/escall_fmt.3.md
@@ -52,7 +52,7 @@ The `esc_scan`() function is similar to `escall_scan`() only without the `r` and
 # ESCAPING
 
 The escaping performed is intended to have the written value inside
-double-quotes. Characters with special escaping are as follow :
+double-quotes. Bytes with special escaping are as follow :
 
 : double-quote (`"`)
 :: Escaped by prefixing with a backslash (`\`)
@@ -83,7 +83,7 @@ double-quotes. Characters with special escaping are as follow :
 
 Anything else will either be written as-in if recognized as a printable
 character in the current locale, else escaped in hex-mode, that is `\x` followed
-by the hexadecimal code of the character. (For example, character 127 would be
+by the hexadecimal code of the byte. (For example, character 127 would be
 escaped as `\x7f`)
 
 # RETURN VALUE
diff --git a/src/doc/pbkdf2.h/pbkdf2.3.md b/src/doc/pbkdf2.h/pbkdf2.3.md
index f2fc38b..d5bee36 100644
--- a/src/doc/pbkdf2.h/pbkdf2.3.md
+++ b/src/doc/pbkdf2.h/pbkdf2.3.md
@@ -11,7 +11,7 @@ pbkdf2 - derive a key from given password & salt using PBKDF2
 
 ```pre hl
 int pbkdf2(char *<em>dst</em>, size_t dlen, hasher *<em>hr</em>, const char *<em>pwd</em>, size_t <em>plen</em>,
-           const char *<em>salt</em>, size_t <em>slen</em>, size_t <em>iter</em)
+           const char *<em>salt</em>, size_t <em>slen</em>, size_t <em>iter</em>)
 ```
 
 # DESCRIPTION
diff --git a/src/doc/posixplz.h/mkfiletemp.3.md b/src/doc/posixplz.h/mkfiletemp.3.md
index 09ed8ad..dfd2a95 100644
--- a/src/doc/posixplz.h/mkfiletemp.3.md
+++ b/src/doc/posixplz.h/mkfiletemp.3.md
@@ -34,7 +34,7 @@ failure due to *EEXIST* a new file name will automatically be generated and a
 new call made.
 
 
-The `mkfiletempat`() function is similar to `mkfiletemp`() but except it takes
+The `mkfiletempat`() function is similar to `mkfiletemp`() except it takes
 a file descriptor `bfd` which will be passed as first argument to `fnat`.
 
 The `fnat` function should create & open a file whose name is pointed by its
diff --git a/src/doc/shldata.h/shldata_initr.3.md b/src/doc/shldata.h/shldata_initr.3.md
index 945e80e..600b85b 100644
--- a/src/doc/shldata.h/shldata_initr.3.md
+++ b/src/doc/shldata.h/shldata_initr.3.md
@@ -41,7 +41,7 @@ As with [ccpl_decrypt](3) it is possible to use the same memory area for both
 It is possible to call this function as many times as needed.
 
 Lastly, the `shldata_finalr`() function will read the memory pointed by `sce`
-(up to a maximum of `sleb` bytes) to authenticate both the derivation parameters
+(up to a maximum of `slen` bytes) to authenticate both the derivation parameters
 used during `shldata_initr`() and the encrypted data.
 
 Once done, it is possible to re-use an opaque structure for a new processing of