tal/str: always create strings which have tal_count() == strlen() + 1.

[ccan] / ccan / tal / str / _info

diff --git a/ccan/tal/str/_info b/ccan/tal/str/_info
index 3037cfde2fba99fcf1e817c0117ed8b89909fee3..9b9c70b6be7f1198e684e23dc0bf892f41fbb04f 100644 (file)
--- a/ccan/tal/str/_info
+++ b/ccan/tal/str/_info
@@ -7,7 +7,9 @@
  *
  * This is a grab bag of functions for string operations, designed to enhance
  * the standard string.h; these are separated from the non-tal-needing
  *
  * This is a grab bag of functions for string operations, designed to enhance
  * the standard string.h; these are separated from the non-tal-needing

- * string utilities in "str.h".
+ * string utilities in "str.h".  Each string created by this library
+ * will have tal_count() equal to strlen() + 1 (assuming you didn't create
+ * a string containing a NUL, such as using tal_fmt("%c", 0)).

  *
  * Example:
  *     #include <ccan/tal/str/str.h>
  *
  * Example:
  *     #include <ccan/tal/str/str.h>