From: Brian Gesiak <modocache@gmail.com>
To: GIT Mailing-list <git@vger.kernel.org>
Cc: Brian Gesiak <modocache@gmail.com>
Subject: [PATCH 2/2] api-strbuf.txt: Add docs for _trim and _ltrim
Date: Wed, 30 Apr 2014 17:58:07 +0900 [thread overview]
Message-ID: <1398848287-77109-2-git-send-email-modocache@gmail.com> (raw)
In-Reply-To: <1398848287-77109-1-git-send-email-modocache@gmail.com>
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>
---
Documentation/technical/api-strbuf.txt | 9 +++++++++
1 file changed, 9 insertions(+)
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
--
1.9.2.507.g779792a
next prev parent reply other threads:[~2014-04-30 8:59 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-04-30 8:58 [PATCH 1/2] strbuf: Use _rtrim and _ltrim in strbuf_trim Brian Gesiak
2014-04-30 8:58 ` Brian Gesiak [this message]
2014-04-30 17:11 ` Jeff King
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1398848287-77109-2-git-send-email-modocache@gmail.com \
--to=modocache@gmail.com \
--cc=git@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).