diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/conf.py | 10 | ||||
| -rw-r--r-- | docs/sds.rst | 9 | ||||
| -rw-r--r-- | docs/sdsfree.rst | 22 | ||||
| -rw-r--r-- | docs/sdsnew.rst | 34 | ||||
| -rw-r--r-- | docs/yasl.rst | 9 | ||||
| -rw-r--r-- | docs/yaslfree.rst | 22 | ||||
| -rw-r--r-- | docs/yaslnew.rst | 35 |
7 files changed, 71 insertions, 70 deletions
diff --git a/docs/conf.py b/docs/conf.py index 8d79a11..630c911 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,8 +1,8 @@ #!/usr/bin/env python3 # -*- coding: utf-8 -*- -project = 'SDS' -master_doc = 'sds' +project = 'YASL' +master_doc = 'yasl' source_suffix = '.rst' show_authors = False @@ -11,7 +11,7 @@ today_fmt = '%d %b %Y' # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - ('sds', 'sds', 'Simple Dynamic String library for C', [], 3), - ('sdsnew', 'sdsnew', 'Create a new SDS string', [], 3), - ('sdsfree', 'sdsfree', 'Free an SDS string', [], 3), + ('yasl', 'yasl', 'Yet Another String Library for C', [], 3), + ('yaslnew', 'yaslnew', 'Create a new yasl string', [], 3), + ('yaslfree', 'yaslfree', 'Free a yasl string', [], 3), ] diff --git a/docs/sds.rst b/docs/sds.rst deleted file mode 100644 index 4f5a0c5..0000000 --- a/docs/sds.rst +++ /dev/null @@ -1,9 +0,0 @@ -:orphan: - -sds -=== - -Functions ---------- - -:manpage:`sdsnew(3)`, :manpage:`sdsnewlen(3)`, :manpage:`sdsfree(3)` diff --git a/docs/sdsfree.rst b/docs/sdsfree.rst deleted file mode 100644 index e4c6cc7..0000000 --- a/docs/sdsfree.rst +++ /dev/null @@ -1,22 +0,0 @@ -: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)` diff --git a/docs/sdsnew.rst b/docs/sdsnew.rst deleted file mode 100644 index 7217b2c..0000000 --- a/docs/sdsnew.rst +++ /dev/null @@ -1,34 +0,0 @@ -:orphan: - -sdsnew -====== - -Synopsis --------- - -.. c:function:: #include <sds.h> - -.. c:function:: sds sdsnew(const char *init) - sds sdsnewlen(const void *init, size_t initlen) - - -Description ------------ - -The function :c:func:`sdsnew()` creates an SDS string from a C null terminated string. - -The function :c:func:`sdsnewlen()` is similar to :c:func:`sdsnew()` but -instead of creating the string assuming that the input string is null -terminated, it gets an additional length parameter. This way you can create a -string from binary data. - -Return value ------------- - -Upon successful completion, these functions will allocate and return a new SDS -string. If the allocation fails they will return :c:data:`NULL`. - -See also --------- - -:manpage:`sds(3)` diff --git a/docs/yasl.rst b/docs/yasl.rst new file mode 100644 index 0000000..fa8872d --- /dev/null +++ b/docs/yasl.rst @@ -0,0 +1,9 @@ +:orphan: + +yasl +==== + +Functions +--------- + +:manpage:`yaslauto(3)`, :manpage:`yaslnew(3)`, :manpage:`yaslfree(3)` diff --git a/docs/yaslfree.rst b/docs/yaslfree.rst new file mode 100644 index 0000000..7292243 --- /dev/null +++ b/docs/yaslfree.rst @@ -0,0 +1,22 @@ +:orphan: + +yaslfree +======== + +Synopsis +-------- + +.. c:function:: #include <yasl.h> + +.. c:function:: void yaslfree(yastr s) + + +Description +----------- + +The function :c:func:`yastrfree()` frees an yasl string, doing nothing if passed a NULL pointer. + +See also +-------- + +:manpage:`yasl(3)` diff --git a/docs/yaslnew.rst b/docs/yaslnew.rst new file mode 100644 index 0000000..8e74f87 --- /dev/null +++ b/docs/yaslnew.rst @@ -0,0 +1,35 @@ +:orphan: + +yaslnew +======= + +Synopsis +-------- + +.. c:function:: #include <yasl.h> + +.. c:function:: yastr yaslauto(const char *init) + yastr yaslnew(const void *init, size_t initlen) + + +Description +----------- + +The function :c:func:`yaslauto()` creates an yasl string from a C null +terminated string. + +The function :c:func:`yaslnew()` is similar to :c:func:`yaslauto()` but instead +of creating the string assuming that the input string is null terminated, it +gets an additional length parameter. This way you can create a string from +binary data. + +Return value +------------ + +Upon successful completion, these functions will allocate and return a new yasl +string. If the allocation fails they will return :c:data:`NULL`. + +See also +-------- + +:manpage:`yasl(3)` |