summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLibravatar Jeff King <peff@peff.net>2015-01-16 04:05:16 -0500
committerLibravatar Junio C Hamano <gitster@pobox.com>2015-01-16 14:40:47 -0800
commit088c9a86ff5332ee15415be3408ccf34687bc2d2 (patch)
tree33af8d2802ddb9f5b0cc8dbaa2899bea2ebaa0ac
parentstrbuf.h: drop asciidoc list formatting from API docs (diff)
downloadtgif-088c9a86ff5332ee15415be3408ccf34687bc2d2.tar.xz
strbuf.h: format asciidoc code blocks as 4-space indent
This is much easier to read when the whole thing is stuffed inside a comment block. And there is precedent for this convention in markdown (and just in general ascii text). Signed-off-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
-rw-r--r--strbuf.h11
1 files changed, 4 insertions, 7 deletions
diff --git a/strbuf.h b/strbuf.h
index ab5ff27980..caa4dad663 100644
--- a/strbuf.h
+++ b/strbuf.h
@@ -33,10 +33,9 @@
* NOTE: It is OK to "play" with the buffer directly if you work it this
* way:
*
- * ----
- * strbuf_grow(sb, SOME_SIZE); <1>
- * strbuf_setlen(sb, sb->len + SOME_OTHER_SIZE);
- * ----
+ * strbuf_grow(sb, SOME_SIZE); <1>
+ * strbuf_setlen(sb, sb->len + SOME_OTHER_SIZE);
+ *
* <1> Here, the memory array starting at `sb->buf`, and of length
* `strbuf_avail(sb)` is all yours, and you can be sure that
* `strbuf_avail(sb)` is at least `SOME_SIZE`.
@@ -261,9 +260,7 @@ extern void strbuf_add(struct strbuf *, const void *, size_t);
* NOTE: This function will *always* be implemented as an inline or a macro
* using strlen, meaning that this is efficient to write things like:
*
- * ----
- * strbuf_addstr(sb, "immediate string");
- * ----
+ * strbuf_addstr(sb, "immediate string");
*
*/
static inline void strbuf_addstr(struct strbuf *sb, const char *s)