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 6fd94dc5654093d3dc909f7175791784f70b9fd4..9b9c70b6be7f1198e684e23dc0bf892f41fbb04f 100644 (file)
--- a/ccan/tal/str/_info
+++ b/ccan/tal/str/_info
@@ -7,11 +7,13 @@
  *
  * 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>
- *     #include <ccan/grab_file/grab_file.h>
+ *     #include <ccan/tal/grab_file/grab_file.h>
  *     #include <err.h>
  *
  *     // Dumb demo program to double-linespace a file.
@@ -20,8 +22,10 @@
  *             char *textfile;
  *             char **lines;
  *
+ *             if (argc > 2)
+ *                     errx(1, "Takes 0 or 1 arguments");
  *             // Grab lines in file.
- *             textfile = grab_file(NULL, argv[1], NULL);
+ *             textfile = grab_file(NULL, argv[1]);
  *             if (!textfile)
  *                     err(1, "Failed reading %s", argv[1]);
  *             lines = tal_strsplit(textfile, textfile, "\n", STR_EMPTY_OK);