diff options
| author | Johannes Löthberg <johannes@kyriasis.com> | 2015-01-18 21:25:09 +0100 |
|---|---|---|
| committer | Johannes Löthberg <johannes@kyriasis.com> | 2015-01-19 00:17:52 +0100 |
| commit | 8b0a680511b9794fa07154ebfa53f71ad6a108d4 (patch) | |
| tree | a9169d6e36d2be8640f4102611c4b24d9e20fb8f | |
| parent | 81d3a025256f2634a51a226df28ae40fafb50de6 (diff) | |
| download | sds-8b0a680511b9794fa07154ebfa53f71ad6a108d4.tar.xz | |
man: Add initial sdsfree(3) manpage
| -rw-r--r-- | Makefile | 2 | ||||
| -rw-r--r-- | docs/sds.rst | 2 | ||||
| -rw-r--r-- | docs/sdsfree.rst | 22 |
3 files changed, 24 insertions, 2 deletions
@@ -3,7 +3,7 @@ CC = clang SOURCES = src/twbctf.c src/sds.c HEADERS = src/twbctf.h src/sds.h -MANPAGES = docs/sds.3 docs/sdsnew.3 +MANPAGES = docs/sds.3 docs/sdsnew.3 docs/sdsfree.3 all: sds-test $(MANPAGES) diff --git a/docs/sds.rst b/docs/sds.rst index 095906f..4f5a0c5 100644 --- a/docs/sds.rst +++ b/docs/sds.rst @@ -6,4 +6,4 @@ sds Functions --------- -:manpage:`sdsnew(3)`, :manpage:`sdsnewlen(3)` +:manpage:`sdsnew(3)`, :manpage:`sdsnewlen(3)`, :manpage:`sdsfree(3)` diff --git a/docs/sdsfree.rst b/docs/sdsfree.rst new file mode 100644 index 0000000..e4c6cc7 --- /dev/null +++ b/docs/sdsfree.rst @@ -0,0 +1,22 @@ +:orphan: + +sdsnew +====== + +Synopsis +-------- + +.. c:function:: #include <sds.h> + +.. c:function:: void sdsfree(sds s) + + +Description +----------- + +The function :c:func:`sdsfree()` frees an SDS string, doing nothing if passed a NULL pointer. + +See also +-------- + +:manpage:`sds(3)` |