lib/string/: Add comments expanding the letter-soup API names

Suggested-by: Serge Hallyn <serge@hallyn.com>
Cc: Chris Bazley <Chris.Bazley@arm.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>

diff --git a/lib/string/strchr/strchrcnt.h b/lib/string/strchr/strchrcnt.h
index 1a1923eacd43e39a3c1bd8621247ccd4a9b929ae..ba76bbdf038893f37f71e7a55db0a53755ead66b 100644 (file)
--- a/lib/string/strchr/strchrcnt.h
+++ b/lib/string/strchr/strchrcnt.h
@@ -18,6 +18,7 @@ ATTR_STRING(1)
 inline size_t strchrcnt(const char *s, char c);
 
 
+// string character count
 inline size_t
 strchrcnt(const char *s, char c)
 {

diff --git a/lib/string/strchr/strchrscnt.h b/lib/string/strchr/strchrscnt.h
index 3d423bd29660c94c58ed15d5360c711b48dee659..2d8b25c7588d77e97d9901edc160511fd271afa0 100644 (file)
--- a/lib/string/strchr/strchrscnt.h
+++ b/lib/string/strchr/strchrscnt.h
@@ -20,6 +20,7 @@ ATTR_STRING(2)
 inline size_t strchrscnt(const char *s, const char *c);
 
 
+// string characters count
 // Similar to strchrcnt(), but search for multiple characters.
 inline size_t
 strchrscnt(const char *s, const char *c)

diff --git a/lib/string/strchr/strnul.h b/lib/string/strchr/strnul.h
index 5754ad0551a72348820a5f538f7b29a1acf18bd2..a55c892ac03a298de2572102447a1489042e8d99 100644 (file)
--- a/lib/string/strchr/strnul.h
+++ b/lib/string/strchr/strnul.h
@@ -13,6 +13,7 @@
 #include "attr.h"
 
 
+// string null-byte
 // Similar to strlen(3), but return a pointer instead of an offset.
 #define strnul(s)                                                             \
 ({                                                                            \

diff --git a/lib/string/strcmp/strcaseeq.h b/lib/string/strcmp/strcaseeq.h
index e93b4770264c901d4f30ba7ba9d56837b56e2749..248903d949e35a06a24c2f251508101909f52a27 100644 (file)
--- a/lib/string/strcmp/strcaseeq.h
+++ b/lib/string/strcmp/strcaseeq.h
@@ -18,6 +18,7 @@ ATTR_STRING(1) ATTR_STRING(2)
 inline bool strcaseeq(const char *s1, const char *s2);
 
 
+// strings case-insensitive equal
 // streq(), but case-insensitive.
 inline bool
 strcaseeq(const char *s1, const char *s2)

diff --git a/lib/string/strcmp/streq.h b/lib/string/strcmp/streq.h
index 267045c5cdde5d49a714ea08bd56ebbdf50055b1..2c7c8392f05b35cfd2ac404facbfae850fc7a6d8 100644 (file)
--- a/lib/string/strcmp/streq.h
+++ b/lib/string/strcmp/streq.h
@@ -19,6 +19,7 @@ ATTR_STRING(2)
 inline bool streq(const char *s1, const char *s2);
 
 
+// strings equal
 /* Return true if s1 and s2 compare equal.  */
 inline bool
 streq(const char *s1, const char *s2)

diff --git a/lib/string/strftime.h b/lib/string/strftime.h
index 578e5f67db8768a76262b34c99172e0abcfee22a..2c86e89d15ed925ba16e64fb008eaa968a7966b0 100644 (file)
--- a/lib/string/strftime.h
+++ b/lib/string/strftime.h
@@ -13,6 +13,7 @@
 #include "sizeof.h"
 
 
+// string format time
 #define STRFTIME(dst, fmt, tm)  strftime(dst, NITEMS(dst), fmt, tm)
 
 

diff --git a/lib/string/strspn/stprcspn.h b/lib/string/strspn/stprcspn.h
index cdd84617cc369c3a4f8a883d3f9c40b3dde6524a..9be7b7fa5982e19ddf8c0485e6f91e8fd65aee4f 100644 (file)
--- a/lib/string/strspn/stprcspn.h
+++ b/lib/string/strspn/stprcspn.h
@@ -13,6 +13,7 @@
 #include "string/strspn/strrcspn.h"
 
 
+// string returns-pointer rear complement substring prefix length
 #define stprcspn(s, reject)                                                   \
 ({                                                                            \
        __auto_type  s_ = (s);                                                \

diff --git a/lib/string/strspn/stprspn.h b/lib/string/strspn/stprspn.h
index 0cdce632f52d60addba3e770e85055a0628aed52..a8a5ef36d8918a55611d64dcb25092bcca0e05e5 100644 (file)
--- a/lib/string/strspn/stprspn.h
+++ b/lib/string/strspn/stprspn.h
@@ -13,6 +13,7 @@
 #include "string/strspn/strrspn.h"
 
 
+// string returns-pointer rear substring prefix length
 // Available in Oracle Solaris as strrspn(3GEN).
 // <https://docs.oracle.com/cd/E36784_01/html/E36877/strrspn-3gen.html>
 #define stprspn(s, accept)                                                    \

diff --git a/lib/string/strspn/stpspn.h b/lib/string/strspn/stpspn.h
index d213cd9ff939184b999bdc2d46ce854dc8c8b6ef..08a10f73f1c397cd4044ff1580c8ae40f5f046f2 100644 (file)
--- a/lib/string/strspn/stpspn.h
+++ b/lib/string/strspn/stpspn.h
@@ -13,6 +13,7 @@
 #include "attr.h"
 
 
+// string returns-pointer substring prefix length
 // Similar to strspn(3), but return a pointer instead of an offset.
 // Similar to strchrnul(3), but search for any bytes not in 'accept'.
 #define stpspn(s, accept)                                                     \

diff --git a/lib/string/strspn/strrcspn.h b/lib/string/strspn/strrcspn.h
index c91453c4db05a51933f8372ac814e71389a33ae7..1510041eb432e889bb2da31efaee1fbfdf7eb2b4 100644 (file)
--- a/lib/string/strspn/strrcspn.h
+++ b/lib/string/strspn/strrcspn.h
@@ -20,6 +20,7 @@ ATTR_STRING(2)
 inline size_t strrcspn(const char *s, const char *reject);
 
 
+// string rear complement substring prefix length
 inline size_t
 strrcspn(const char *s, const char *reject)
 {

diff --git a/lib/string/strspn/strrspn.h b/lib/string/strspn/strrspn.h
index ea703ff44bf3734341f3c8df115c3fdf13e371ce..6e2e6bfab67e612b6a37e1b6324ec967baf0b19a 100644 (file)
--- a/lib/string/strspn/strrspn.h
+++ b/lib/string/strspn/strrspn.h
@@ -20,6 +20,7 @@ ATTR_STRING(2)
 inline size_t strrspn_(const char *s, const char *accept);
 
 
+// string rear substring prefix length
 inline size_t
 strrspn_(const char *s, const char *accept)
 {

diff --git a/lib/string/strtok/stpsep.h b/lib/string/strtok/stpsep.h
index f084bc461549d56d815d33b4728b27a6b3da69b8..782b11fd43b6a1e252f0828020b4c5d5e961b3b4 100644 (file)
--- a/lib/string/strtok/stpsep.h
+++ b/lib/string/strtok/stpsep.h
@@ -17,6 +17,7 @@ ATTR_STRING(1) ATTR_STRING(2)
 inline char *stpsep(char *s, const char *delim);
 
 
+// string returns-pointer separate
 // Similar to strsep(3),
 // but return the next token, and don't update the input pointer.
 // Similar to strtok(3),