summaryrefslogtreecommitdiff
path: root/strbuf.h
diff options
context:
space:
mode:
authorMichael Witten <mfwitten@gmail.com>2011-02-15 23:12:04 +0000
committerJunio C Hamano <gitster@pobox.com>2011-03-30 12:02:50 -0700
commite0390119b249252a633875e4327c8a6463e4b6cb (patch)
tree9927729d652264285e28fd7e2f4ba97b7b7e63b2 /strbuf.h
parent63d329459370b09637d49a430f63d3ecd2bc3f25 (diff)
downloadgit-e0390119b249252a633875e4327c8a6463e4b6cb.tar.gz
strbuf.h: remove a tad stale docs-in-comment and reference api-doc instead
Signed-off-by: Michael Witten <mfwitten@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'strbuf.h')
-rw-r--r--strbuf.h37
1 files changed, 1 insertions, 36 deletions
diff --git a/strbuf.h b/strbuf.h
index 675a91f938..4ce7dedee0 100644
--- a/strbuf.h
+++ b/strbuf.h
@@ -1,42 +1,7 @@
#ifndef STRBUF_H
#define STRBUF_H
-/*
- * Strbuf's can be use in many ways: as a byte array, or to store arbitrary
- * long, overflow safe strings.
- *
- * Strbufs has some invariants that are very important to keep in mind:
- *
- * 1. the ->buf member is always malloc-ed, hence strbuf's can be used to
- * build complex strings/buffers whose final size isn't easily known.
- *
- * It is NOT legal to copy the ->buf pointer away.
- * `strbuf_detach' is the operation that detaches a buffer from its shell
- * while keeping the shell valid wrt its invariants.
- *
- * 2. 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 ensures this
- * invariant is preserved.
- *
- * Note that it is OK to "play" with the buffer directly if you work it
- * that way:
- *
- * strbuf_grow(sb, SOME_SIZE);
- * ... Here, the memory array starting at sb->buf, and of length
- * ... strbuf_avail(sb) is all yours, and you are sure that
- * ... strbuf_avail(sb) is at least SOME_SIZE.
- * strbuf_setlen(sb, sb->len + SOME_OTHER_SIZE);
- *
- * Of course, 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.
- *
- * XXX: 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.
- */
+/* See Documentation/technical/api-strbuf.txt */
#include <assert.h>