Skip to content

Commit

Permalink
api-strbuf.txt: fix typos and document launch_editor()
Browse files Browse the repository at this point in the history
Signed-off-by: Stephen Boyd <bebarino@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
  • Loading branch information
Stephen Boyd authored and Junio C Hamano committed Dec 18, 2009
1 parent 527b9d7 commit 63b7694
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions Documentation/technical/api-strbuf.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ strbuf API actually relies on the string being free of NULs.

strbufs has some invariants that are very important to keep in mind:

. The `buf` member is never NULL, so you it can be used in any usual C
. 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.
+
Expand Down Expand Up @@ -55,7 +55,7 @@ Data structures

* `struct strbuf`

This is string buffer structure. The `len` member can be used to
This is the string buffer structure. The `len` member can be used to
determine the current length of the string, and `buf` member provides access to
the string itself.

Expand Down Expand Up @@ -253,3 +253,9 @@ same behaviour as well.
comments are considered contents to be removed or not.

`launch_editor`::

Launch the user preferred editor to edit a file and fill the buffer
with the file's contents upon the user completing their editing. The
third argument can be used to set the environment which the editor is
run in. If the buffer is NULL the editor is launched as usual but the
file's contents are not read into the buffer upon completion.

0 comments on commit 63b7694

Please sign in to comment.