From: Alejandro Colomar <alx@kernel.org>
Date: Fri, 31 Oct 2025 10:07:32 +0000 (+0100)
Subject: lib/string/README: Document *_a() macros
X-Git-Tag: 4.19.0-rc1~63
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=4f523497dfcc4e0a035fc9817911e0932232a80a;p=thirdparty%2Fshadow.git

lib/string/README: Document *_a() macros

Signed-off-by: Alejandro Colomar <alx@kernel.org>
---

diff --git a/lib/string/README b/lib/string/README
index 8072e85f7..25e2cdf10 100644
--- a/lib/string/README
+++ b/lib/string/README
@@ -4,6 +4,9 @@ General guidelines:
 -  If there's an upper-case macro that wraps a function, use the macro
    if possible.  These use macro magic to add safety.
 
+-  If there's a *_a() macro that wraps an API, use the macro if
+   possible.  These use countof() to add bounds safety.
+
 -  x*() functions wrap a function of the same name without the 'x'.
    These wrappers exit on error instead of returning NULL.
    They simplify program code.  Avoid them in library code.