git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jeff King <peff@peff.net>
To: Jonathan Nieder <jrnieder@gmail.com>
Cc: Stefan Beller <sbeller@google.com>,
	Junio C Hamano <gitster@pobox.com>,
	"git@vger.kernel.org" <git@vger.kernel.org>,
	Michael Haggerty <mhagger@alum.mit.edu>
Subject: [PATCH 2/4] strbuf.h: drop asciidoc list formatting from API docs
Date: Fri, 12 Dec 2014 16:28:20 -0500	[thread overview]
Message-ID: <20141212212820.GB27451@peff.net> (raw)
In-Reply-To: <20141212212726.GA26284@peff.net>

Using a hanging indent is much more readable. This means we
won't format as asciidoc anymore, but since we don't have a
working system for extracting these comments anyway, it's
probably more important to just make the source readable.

Signed-off-by: Jeff King <peff@peff.net>
---
 strbuf.h | 74 ++++++++++++++++++++++++++++++++--------------------------------
 1 file changed, 37 insertions(+), 37 deletions(-)

diff --git a/strbuf.h b/strbuf.h
index 0a83f9a..8f63b38 100644
--- a/strbuf.h
+++ b/strbuf.h
@@ -13,44 +13,44 @@
  *
  * strbufs have some invariants that are very important to keep in mind:
  *
- * . The `buf` member is never NULL, so it can be used in any usual C
- * string operations safely. strbuf's _have_ to be initialized either by
- * `strbuf_init()` or by `= STRBUF_INIT` before the invariants, though.
- * +
- * Do *not* assume anything on what `buf` really is (e.g. if it is
- * allocated memory or not), use `strbuf_detach()` to unwrap a memory
- * buffer from its strbuf shell in a safe way. That is the sole supported
- * way. This will give you a malloced buffer that you can later `free()`.
- * +
- * However, it is totally safe to modify anything in the string pointed by
- * the `buf` member, between the indices `0` and `len-1` (inclusive).
+ *  - The `buf` member is never NULL, so it can be used in any usual C
+ *    string operations safely. strbuf's _have_ to be initialized either by
+ *    `strbuf_init()` or by `= STRBUF_INIT` before the invariants, though.
  *
- * . The `buf` member is a byte array that has at least `len + 1` bytes
- *   allocated. The extra byte is used to store a `'\0'`, allowing the
- *   `buf` member to be a valid C-string. Every strbuf function ensure this
- *   invariant is preserved.
- * +
- * 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);
- * ----
- * <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`.
- * +
- * NOTE: `SOME_OTHER_SIZE` must be smaller or equal to `strbuf_avail(sb)`.
- * +
- * Doing so is safe, though if it has to be done in many places, adding the
- * missing API to the strbuf module is the way to go.
- * +
- * WARNING: Do _not_ assume that the area that is yours is of size `alloc
- * - 1` even if it's true in the current implementation. Alloc is somehow a
- * "private" member that should not be messed with. Use `strbuf_avail()`
- * instead.
- */
+ *    Do *not* assume anything on what `buf` really is (e.g. if it is
+ *    allocated memory or not), use `strbuf_detach()` to unwrap a memory
+ *    buffer from its strbuf shell in a safe way. That is the sole supported
+ *    way. This will give you a malloced buffer that you can later `free()`.
+ *
+ *    However, it is totally safe to modify anything in the string pointed by
+ *    the `buf` member, between the indices `0` and `len-1` (inclusive).
+ *
+ *  - The `buf` member is a byte array that has at least `len + 1` bytes
+ *    allocated. The extra byte is used to store a `'\0'`, allowing the
+ *    `buf` member to be a valid C-string. Every strbuf function ensure this
+ *    invariant is preserved.
+ *
+ *    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);
+ *    ----
+ *    <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`.
+ *
+ *    NOTE: `SOME_OTHER_SIZE` must be smaller or equal to `strbuf_avail(sb)`.
+ *
+ *    Doing so is safe, though if it has to be done in many places, adding the
+ *    missing API to the strbuf module is the way to go.
+ *
+ *    WARNING: Do _not_ assume that the area that is yours is of size `alloc
+ *    - 1` even if it's true in the current implementation. Alloc is somehow a
+ *    "private" member that should not be messed with. Use `strbuf_avail()`
+ *    instead.
+*/
 
 /*
  * Data Structures
-- 
2.2.0.454.g7eca6b7

  parent reply	other threads:[~2014-12-12 21:28 UTC|newest]

Thread overview: 49+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-12-06  1:51 [PATCH] document string_list_clear Stefan Beller
2014-12-06  2:04 ` Jonathan Nieder
2014-12-06  5:27   ` Jeff King
2014-12-06  5:30   ` Jeff King
2014-12-09 19:41     ` Junio C Hamano
2014-12-09 20:15       ` Jeff King
2014-12-09 20:21         ` Jonathan Nieder
2014-12-09 19:37   ` Junio C Hamano
2014-12-09 19:48     ` Stefan Beller
2014-12-09 20:17       ` Jonathan Nieder
2014-12-09 20:27         ` Jeff King
2014-12-09 20:32           ` Stefan Beller
2014-12-09 20:46             ` Jeff King
2014-12-09 22:23           ` Jonathan Nieder
2014-12-09 23:18             ` Junio C Hamano
2014-12-10  8:52               ` Jeff King
2014-12-10  8:43             ` Jeff King
2014-12-10  9:18               ` Jonathan Nieder
2014-12-12  9:16                 ` Jeff King
2014-12-12 18:31                   ` Jonathan Nieder
2014-12-12 19:17                     ` Junio C Hamano
2014-12-12 19:19                     ` Stefan Beller
2014-12-12 19:29                       ` Jeff King
2014-12-12 19:24                     ` Jeff King
2014-12-12 19:35                       ` Jonathan Nieder
2014-12-12 21:27                         ` Jeff King
2014-12-12 21:28                           ` [PATCH 1/4] strbuf: migrate api-strbuf.txt documentation to strbuf.h Jeff King
2014-12-12 21:40                             ` Jeff King
2014-12-12 22:16                             ` Junio C Hamano
2014-12-12 22:30                             ` Jonathan Nieder
2014-12-12 21:28                           ` Jeff King [this message]
2014-12-12 22:19                             ` [PATCH 2/4] strbuf.h: drop asciidoc list formatting from API docs Junio C Hamano
2014-12-12 22:37                             ` Jonathan Nieder
2014-12-12 21:30                           ` [PATCH 3/4] strbuf.h: format asciidoc code blocks as 4-space indent Jeff King
2014-12-12 22:39                             ` Jonathan Nieder
2014-12-14 17:42                               ` Michael Haggerty
2014-12-12 21:32                           ` [PATCH 4/4] strbuf.h: reorganize api function grouping headers Jeff King
2014-12-12 22:46                             ` Jonathan Nieder
2014-12-12 22:32                           ` [PATCH] document string_list_clear Stefan Beller
2014-12-10 20:09               ` Michael Haggerty
2014-12-10 21:51                 ` Jonathan Nieder
2014-12-10 22:28                   ` Junio C Hamano
2014-12-10 22:37                     ` Jonathan Nieder
2014-12-10 23:04                       ` Junio C Hamano
2014-12-10 23:08                         ` Jonathan Nieder
2014-12-09 22:49         ` Jonathan Nieder
2014-12-09 23:07           ` Stefan Beller
2014-12-09 23:15             ` Jonathan Nieder
2014-12-09 20:00     ` Jonathan Nieder

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=20141212212820.GB27451@peff.net \
    --to=peff@peff.net \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=jrnieder@gmail.com \
    --cc=mhagger@alum.mit.edu \
    --cc=sbeller@google.com \
    /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).