git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH 4/7] strbuf.h: format asciidoc code blocks as 4-space indent

From
Jeff King <peff@peff.net>
Date
Jan 16, 2015, 09:05 UTC
Message-ID
<20150116090515.GD31113@peff.net>
In-Reply-To
<20150116090225.GA30797@peff.net>

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>
---
 strbuf.h | 11 ++++-------
 1 file changed, 4 insertions(+), 7 deletions(-)
diff --git a/strbuf.h b/strbuf.h
index ab5ff27..caa4dad 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)
-- 
2.2.1.425.g441bb3c
Previous: Jeff KingNext: Jeff King
Message 5 of 12 in “migrate api-strbuf.txt into strbuf.h”
  1. 0/7 migrate api-strbuf.txt into strbuf.hJeff King, Jan 16, 2015
  2. 1/7 strbuf.h: integrate api-strbuf.txt documentationJeff King, Jan 16, 2015
  3. 2/7 strbuf.h: unify documentation comments beginningsJeff King, Jan 16, 2015
  4. 3/7 strbuf.h: drop asciidoc list formatting from API docsJeff King, Jan 16, 2015
  5. 4/7 strbuf.h: format asciidoc code blocks as 4-space indentJeff King, Jan 16, 2015
  6. 5/7 strbuf.h: reorganize api function grouping headersJeff King, Jan 16, 2015
  7. 6/7 strbuf.h: drop boilerplate descriptions of strbuf_split_*Jeff King, Jan 16, 2015
  8. 7/7 strbuf.h: group documentation for trim functionsJeff King, Jan 16, 2015
  9. Junio C HamanoFeb 12, 2015
  10. Jeff KingFeb 12, 2015
  11. Junio C HamanoFeb 16, 2015
  12. Jonathan NiederFeb 17, 2015

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.