api-strbuf.txt: fix typos and document launch_editor()
Signed-off-by: Stephen Boyd <bebarino@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Stephen Boyd committed
Dec 17, 2009 at 16:05 UTC
63b76948e1d211ad4a95c3a9c7a0087fe6a1e371
1 file changed
+8
-2
Documentation/technical/api-strbuf.txt
+8
-2
@@ -12,7 +12,7 @@ strbuf API actually relies on the string being free of NULs.
12
13
strbufs has some invariants that are very important to keep in mind:
14
15
-. The `buf` member is never NULL, so you it can be used in any usual C
15
+. The `buf` member is never NULL, so it can be used in any usual C
16
string operations safely. strbuf's _have_ to be initialized either by
17
`strbuf_init()` or by `= STRBUF_INIT` before the invariants, though.
18
+
@@ -55,7 +55,7 @@ Data structures
55
56
* `struct strbuf`
57
58
-This is string buffer structure. The `len` member can be used to
58
+This is the string buffer structure. The `len` member can be used to
59
determine the current length of the string, and `buf` member provides access to
60
the string itself.
61
@@ -253,3 +253,9 @@ same behaviour as well.
253
comments are considered contents to be removed or not.
254
255
`launch_editor`::
256
+
257
+ Launch the user preferred editor to edit a file and fill the buffer
258
+ with the file's contents upon the user completing their editing. The
259
+ third argument can be used to set the environment which the editor is
260
+ run in. If the buffer is NULL the editor is launched as usual but the
261
+ file's contents are not read into the buffer upon completion.