Fix comment in strbuf.h to use correct name strbuf_avail()

sprohaska · gitster · commit a1f611d5d03d · 2007-11-05T21:09:39.000-08:00
Signed-off-by: Steffen Prohaska &lt;prohaska@zib.de&gt;
Signed-off-by: Junio C Hamano &lt;gitster@pobox.com&gt;
diff --git a/strbuf.h b/strbuf.h
@@ -23,12 +23,12 @@
  *    that way:
  *
  *    strbuf_grow(sb, SOME_SIZE);
- *    // ... here the memory areay starting at sb->buf, and of length
- *    // sb_avail(sb) is all yours, and you are sure that sb_avail(sb) is at
- *    // least 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 sb_avail(sb).
+ *    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.

Original file line number	Diff line number	Diff line change
`@@ -23,12 +23,12 @@`
`23`	`23`	`* that way:`
`24`	`24`	`*`
`25`	`25`	`* strbuf_grow(sb, SOME_SIZE);`
`26`		`- * // ... here the memory areay starting at sb->buf, and of length`
`27`		`- * // sb_avail(sb) is all yours, and you are sure that sb_avail(sb) is at`
`28`		`- * // least SOME_SIZE`
	`26`	`+ * ... Here, the memory array starting at sb->buf, and of length`
	`27`	`+ * ... strbuf_avail(sb) is all yours, and you are sure that`
	`28`	`+ * ... strbuf_avail(sb) is at least SOME_SIZE.`
`29`	`29`	`* strbuf_setlen(sb, sb->len + SOME_OTHER_SIZE);`
`30`	`30`	`*`
`31`		`- * Of course, SOME_OTHER_SIZE must be smaller or equal to sb_avail(sb).`
	`31`	`+ * Of course, SOME_OTHER_SIZE must be smaller or equal to strbuf_avail(sb).`
`32`	`32`	`*`
`33`	`33`	`* Doing so is safe, though if it has to be done in many places, adding the`
`34`	`34`	`* missing API to the strbuf module is the way to go.`