kernel
/
git
mirror of https://git.kernel.org/pub/scm/git/git.git
1
0
Fork 0
Code Releases Activity

api-strbuf.txt: add docs for _trim and _ltrim 

API documentation for strbuf does not document strbuf_trim() or
strbuf_ltrim(). Add documentation for these two functions.

Signed-off-by: Brian Gesiak <modocache@gmail.com>
Reviewed-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
maint
Brian Gesiak 2014-04-30 17:58:07 +09:00 committed by Junio C Hamano
parent 3bb55e8aa8
commit 10f5b034b6
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
Documentation/technical/api-strbuf.txt
View File

@ -121,10 +121,19 @@ Functions


* Related to the contents of the buffer * 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`:: `strbuf_rtrim`::


Strip whitespace from the end of a string. Strip whitespace from the end of a string.


`strbuf_ltrim`::

Strip whitespace from the beginning of a string.

`strbuf_cmp`:: `strbuf_cmp`::


Compare two buffers. Returns an integer less than, equal to, or greater Compare two buffers. Returns an integer less than, equal to, or greater