diff options
| author |  Junio C Hamano <gitster@pobox.com> | 2012-11-15 10:24:49 -0800 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2012-11-15 10:24:49 -0800 |
| commit | 2be3d85a1c3760cba0960723ffed165f45fa36c6 (patch) | |
| tree | d5f758c5eaa456e2f8799d1bb7c018ab052f2153 /Documentation/technical | |
| parent | Merge branch 'mm/maint-doc-commit-edit' (diff) | |
| parent | strbuf_split*(): document functions (diff) | |
| download | tgif-2be3d85a1c3760cba0960723ffed165f45fa36c6.tar.xz | |
Merge branch 'mh/strbuf-split'
Cleanups and documentation for strbuf_split.
* mh/strbuf-split:
strbuf_split*(): document functions
strbuf_split*(): rename "delim" parameter to "terminator"
strbuf_split_buf(): simplify iteration
strbuf_split_buf(): use ALLOC_GROW()
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 |