diff options
| author | Michael Haggerty <mhagger@alum.mit.edu> | 2012-11-04 07:46:54 +0100 |
|---|---|---|
| committer | Jeff King <peff@peff.net> | 2012-11-04 06:46:55 -0500 |
| commit | 06379a65098212aef05010598ba3a8549bd78474 (patch) | |
| tree | aa10993ab7b204ace83128e765d9515108eaedcc /Documentation/technical | |
| parent | 17b73dc699c46d7af5d29d2f3813e7addafdce0d (diff) | |
| download | git-06379a65098212aef05010598ba3a8549bd78474.tar.gz | |
strbuf_split*(): document functions
Document strbuf_split_buf(), strbuf_split_str(), strbuf_split_max(),
strbuf_split(), and strbuf_list_free() in the header file and in
api-strbuf.txt. (These functions were previously completely
undocumented.)
Signed-off-by: Michael Haggerty <mhagger@alum.mit.edu>
Signed-off-by: Jeff King <peff@peff.net>
Diffstat (limited to 'Documentation/technical')
| -rw-r--r-- | Documentation/technical/api-strbuf.txt | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/Documentation/technical/api-strbuf.txt b/Documentation/technical/api-strbuf.txt index 95a8bf3846..84686b5c69 100644 --- a/Documentation/technical/api-strbuf.txt +++ b/Documentation/technical/api-strbuf.txt @@ -279,6 +279,22 @@ same behaviour as well. Strip whitespace from a buffer. The second parameter controls if comments are considered contents to be removed or not. +`strbuf_split_buf`:: +`strbuf_split_str`:: +`strbuf_split_max`:: +`strbuf_split`:: + + Split a string or strbuf into a list of strbufs at a specified + terminator character. The returned substrings include the + terminator characters. Some of these functions take a `max` + parameter, which, if positive, limits the output to that + number of substrings. + +`strbuf_list_free`:: + + Free a list of strbufs (for example, the return values of the + `strbuf_split()` functions). + `launch_editor`:: Launch the user preferred editor to edit a file and fill the buffer |