Merge branch 'as/calloc-takes-nmemb-then-size'
[gitweb.git] / Documentation / technical / api-strbuf.txt
index 077a7096a4ba3c47a0cbc8981abdde1b7b35d924..430302c2f4ee8c3881d663b1f395234fd8cad0a3 100644 (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
 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.
 
-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
 string operations safely. strbuf's _have_ to be initialized either by
@@ -56,8 +56,8 @@ Data structures
 * `struct strbuf`
 
 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.
+determine the current length of the string, and `buf` member provides
+access to the string itself.
 
 Functions
 ---------
@@ -202,7 +202,7 @@ strbuf_addstr(sb, "immediate string");
 
 `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`::
 
@@ -307,6 +307,16 @@ same behaviour as well.
        use it unless you need the correct position in the file
        descriptor.
 
+`strbuf_getcwd`::
+
+       Set the buffer to the path of the current working directory.
+
+`strbuf_add_absolute_path`
+
+       Add a path to a buffer, converting a relative path to an
+       absolute one in the process.  Symbolic links are not
+       resolved.
+
 `stripspace`::
 
        Strip whitespace from a buffer. The second parameter controls if