undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge branch 'jm/api-strbuf-doc' into maint

Browse Source 
* jm/api-strbuf-doc:
  api-strbuf.txt minor typos
This commit is contained in:
Junio C Hamano 2014-07-22 10:26:52 -07:00
commit 0196a605f7
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Documentation/technical/api-strbuf.txt
View File

@ -7,10 +7,10 @@ use the mem* functions than a str* one (memchr vs. strchr e.g.).
Though, one has to be careful about the fact that str* functions often Though, one has to be careful about the fact that str* functions often
stop on NULs and that strbufs may have embedded NULs. stop on NULs and that strbufs may have embedded NULs.
An strbuf is NUL terminated for convenience, but no function in the A strbuf is NUL terminated for convenience, but no function in the
strbuf API actually relies on the string being free of NULs. strbuf API actually relies on the string being free of NULs.
strbufs has some invariants that are very important to keep in mind: strbufs have some invariants that are very important to keep in mind:
. The `buf` member is never NULL, so 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 string operations safely. strbuf's _have_ to be initialized either by
@ -56,8 +56,8 @@ Data structures
* `struct strbuf` * `struct strbuf`
This is the 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 determine the current length of the string, and `buf` member provides
the string itself. access to the string itself.
Functions Functions
--------- ---------
@ -184,7 +184,7 @@ strbuf_addstr(sb, "immediate string");
`strbuf_addbuf`:: `strbuf_addbuf`::
Copy the contents of an other buffer at the end of the current one. Copy the contents of another buffer at the end of the current one.
`strbuf_adddup`:: `strbuf_adddup`::