From: Junio C Hamano Date: Fri, 20 Jun 2014 20:12:10 +0000 (-0700) Subject: Merge branch 'jm/api-strbuf-doc' X-Git-Tag: v2.1.0-rc0~97 X-Git-Url: https://git.lorimer.id.au/gitweb.git/diff_plain/9ba66403fd1307fac258167d28d5a16facbe2521?hp=-c Merge branch 'jm/api-strbuf-doc' * jm/api-strbuf-doc: api-strbuf.txt minor typos --- 9ba66403fd1307fac258167d28d5a16facbe2521 diff --combined Documentation/technical/api-strbuf.txt index 077a7096a4,1d00e4d596..f9c06a7573 --- a/Documentation/technical/api-strbuf.txt +++ b/Documentation/technical/api-strbuf.txt @@@ -7,10 -7,10 +7,10 @@@ use the mem* functions than a str* one Though, one has to be careful about the fact that str* functions often stop on NULs and that strbufs may have embedded NULs. - An strbuf is NUL terminated for convenience, but no function in the + A strbuf is NUL terminated for convenience, but no function in the strbuf API actually relies on the string being free of NULs. - strbufs has some invariants that are very important to keep in mind: + strbufs have some invariants that are very important to keep in mind: . The `buf` member is never NULL, so it can be used in any usual C string operations safely. strbuf's _have_ to be initialized either by @@@ -56,8 -56,8 +56,8 @@@ Data structure * `struct strbuf` This is the string buffer structure. The `len` member can be used to - determine the current length of the string, and `buf` member provides access to - the string itself. + determine the current length of the string, and `buf` member provides + access to the string itself. Functions --------- @@@ -121,28 -121,10 +121,28 @@@ * Related to the contents of the buffer +`strbuf_trim`:: + + Strip whitespace from the beginning and end of a string. + Equivalent to performing `strbuf_rtrim()` followed by `strbuf_ltrim()`. + `strbuf_rtrim`:: Strip whitespace from the end of a string. +`strbuf_ltrim`:: + + Strip whitespace from the beginning of a string. + +`strbuf_reencode`:: + + Replace the contents of the strbuf with a reencoded form. Returns -1 + on error, 0 on success. + +`strbuf_tolower`:: + + Lowercase each character in the buffer using `tolower`. + `strbuf_cmp`:: Compare two buffers. Returns an integer less than, equal to, or greater @@@ -202,7 -184,7 +202,7 @@@ strbuf_addstr(sb, "immediate string") `strbuf_addbuf`:: - Copy the contents of an other buffer at the end of the current one. + Copy the contents of another buffer at the end of the current one. `strbuf_adddup`::