summaryrefslogtreecommitdiff
path: root/Documentation/technical
diff options
context:
space:
mode:
authorBrian Gesiak <modocache@gmail.com>2014-04-30 08:58:07 (GMT)
committerJunio C Hamano <gitster@pobox.com>2014-05-06 22:33:58 (GMT)
commit10f5b034b6aaff706c4776b3cc0ee993c33e8f43 (patch)
treea58db5789d19a16013fee1dee93f1e3b3c3d7913 /Documentation/technical
parent3bb55e8aa86f054c081c372b227f723e3aad14c7 (diff)
downloadgit-10f5b034b6aaff706c4776b3cc0ee993c33e8f43.zip
git-10f5b034b6aaff706c4776b3cc0ee993c33e8f43.tar.gz
git-10f5b034b6aaff706c4776b3cc0ee993c33e8f43.tar.bz2
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>
Diffstat (limited to 'Documentation/technical')
-rw-r--r--Documentation/technical/api-strbuf.txt9
1 files changed, 9 insertions, 0 deletions
diff --git a/Documentation/technical/api-strbuf.txt b/Documentation/technical/api-strbuf.txt
index 3350d97..4396be9 100644
--- a/Documentation/technical/api-strbuf.txt
+++ b/Documentation/technical/api-strbuf.txt
@@ -121,10 +121,19 @@ Functions
* 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_cmp`::
Compare two buffers. Returns an integer less than, equal to, or greater