summaryrefslogtreecommitdiff
path: root/strbuf.h
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2011-03-30 14:10:41 -0700
committerJunio C Hamano <gitster@pobox.com>2011-03-30 14:10:41 -0700
commit17a02998078923f2d62811326d130de991d1a95a (patch)
treef33b6e5758233f3f7ae05fe0d8565323de381820 /strbuf.h
parent44a9cedb005b0b8be31dccd8e6ddf97074a01345 (diff)
parent806e0aba2e5d976233703e6ff517af10329e4048 (diff)
downloadgit-17a02998078923f2d62811326d130de991d1a95a.tar.gz
Merge branch 'maint'
* maint: contrib/thunderbird-patch-inline: do not require bash to run the script t8001: check the exit status of the command being tested strbuf.h: remove a tad stale docs-in-comment and reference api-doc instead Typos: t/README Documentation/config.txt: make truth value of numbers more explicit git-pack-objects.txt: fix grammatical errors parse-remote: replace unnecessary sed invocation
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 f722331470..07060ce893 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>