expect this commit to be force-replaced periodically

[nmh] / sbr / brkstring.h

diff --git a/sbr/brkstring.h b/sbr/brkstring.h
index f727179ec1e7ab0e1bd7632f4625ba64f5e95e98..55d47b23c2034ac1891b65417424b846b35e7db3 100644 (file)
--- a/sbr/brkstring.h
+++ b/sbr/brkstring.h
@@ -5,4 +5,9 @@
  * COPYRIGHT file in the root directory of the nmh distribution for
  * complete copyright information. */
 
-char **brkstring(char *, char *, char *) NONNULL(1);
+/* Break up str on characters in brksep, terminated by brkterm.
+ * Each character in str that exists in brksep is replace with a null byte.
+ * Processing stops at the first character in str that exists in brkterm.
+ * Directly mutates str.
+ * Returns pointer to private, static array of pointers into str. */
+char *const *brkstring(char *str, char const *brksep, char const *brkterm) NONNULL(1);