docs: changed headers.
This commit is contained in:
parent
a0577471e2
commit
a5201deaee
10 changed files with 31 additions and 31 deletions
|
|
@ -1,11 +1,11 @@
|
||||||
Configuration
|
Configuration
|
||||||
--------------
|
=============
|
||||||
|
|
||||||
Archive uses a .ini style configuration. The following options are
|
Archive uses a .ini style configuration. The following options are
|
||||||
available.
|
available.
|
||||||
|
|
||||||
Value types
|
Value types
|
||||||
~~~~~~~~~~~
|
-----------
|
||||||
|
|
||||||
Boolean ;;
|
Boolean ;;
|
||||||
True: Y, T, 1 +
|
True: Y, T, 1 +
|
||||||
|
|
@ -15,10 +15,10 @@ String ;;
|
||||||
Anything else.
|
Anything else.
|
||||||
|
|
||||||
Options
|
Options
|
||||||
~~~~~~~
|
-------
|
||||||
|
|
||||||
Log
|
Log
|
||||||
^^^
|
~~~
|
||||||
Options available in the log section
|
Options available in the log section
|
||||||
|
|
||||||
use (Boolean);;
|
use (Boolean);;
|
||||||
|
|
@ -35,7 +35,7 @@ directory (String);;
|
||||||
|
|
||||||
|
|
||||||
Mysql
|
Mysql
|
||||||
^^^^^
|
~~~
|
||||||
Options available in the mysql section
|
Options available in the mysql section
|
||||||
|
|
||||||
host (String);;
|
host (String);;
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
Notify API
|
Notify API
|
||||||
----------
|
==========
|
||||||
|
|
||||||
This API is here to provide an abstraction to the underlaying low-level filesystem notification mechanism
|
This API is here to provide an abstraction to the underlaying low-level filesystem notification mechanism
|
||||||
to try to make applications portable but also throw away detail from client-code.
|
to try to make applications portable but also throw away detail from client-code.
|
||||||
|
|
@ -8,7 +8,7 @@ IMPORTANT: The design is only tested with inotify and the API may
|
||||||
need to change in the future to support more subsystems that may have some limitations.
|
need to change in the future to support more subsystems that may have some limitations.
|
||||||
|
|
||||||
Data structures
|
Data structures
|
||||||
~~~~~~~~~~~~~~~
|
---------------
|
||||||
|
|
||||||
* `notify_event`
|
* `notify_event`
|
||||||
|
|
||||||
|
|
@ -47,7 +47,7 @@ NOTIFY_MOVE_TO;;
|
||||||
the filename the event was triggered on
|
the filename the event was triggered on
|
||||||
|
|
||||||
Functions
|
Functions
|
||||||
~~~~~~~~~
|
---------
|
||||||
|
|
||||||
`notify_init()`::
|
`notify_init()`::
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,10 +1,10 @@
|
||||||
fscrawl - Filesystem traversal
|
fscrawl - Filesystem traversal
|
||||||
------------------------------
|
==============================
|
||||||
|
|
||||||
API for traversing a filesystem tree/subtree.
|
API for traversing a filesystem tree/subtree.
|
||||||
|
|
||||||
Data Structures
|
Data Structures
|
||||||
~~~~~~~~~~~~~~~
|
---------------
|
||||||
|
|
||||||
* `fscrawl_t`
|
* `fscrawl_t`
|
||||||
|
|
||||||
|
|
@ -24,7 +24,7 @@ Holds information about a node on the filesystem
|
||||||
zero if the entry is a file, non zero otherwise
|
zero if the entry is a file, non zero otherwise
|
||||||
|
|
||||||
Functions
|
Functions
|
||||||
~~~~~~~~~
|
---------
|
||||||
|
|
||||||
`fsc_open()`::
|
`fsc_open()`::
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,12 +1,12 @@
|
||||||
Log - Message logging API
|
Log - Message logging API
|
||||||
-------------------------
|
=========================
|
||||||
|
|
||||||
This interface is designed in such way that code that wants to log a massage can do so with one call and don't worry
|
This interface is designed in such way that code that wants to log a massage can do so with one call and don't worry
|
||||||
about where it may turn up and what format it should use etc. +
|
about where it may turn up and what format it should use etc. +
|
||||||
All this is setup trough one function call idealy in the beginning of a process.
|
All this is setup trough one function call idealy in the beginning of a process.
|
||||||
|
|
||||||
Macros
|
Macros
|
||||||
~~~~~~
|
------
|
||||||
|
|
||||||
`LOG_INFO`::
|
`LOG_INFO`::
|
||||||
Information, Someone thinks you may find this important.
|
Information, Someone thinks you may find this important.
|
||||||
|
|
@ -24,7 +24,7 @@ Macros
|
||||||
All of the above.
|
All of the above.
|
||||||
|
|
||||||
Functions
|
Functions
|
||||||
~~~~~~~~~
|
---------
|
||||||
|
|
||||||
`init_log()`::
|
`init_log()`::
|
||||||
Initialize the logging functionality, 'level' is a bitmask of the LOG_* contansts defining what types of messages should be logged. +
|
Initialize the logging functionality, 'level' is a bitmask of the LOG_* contansts defining what types of messages should be logged. +
|
||||||
|
|
|
||||||
|
|
@ -1,10 +1,10 @@
|
||||||
Path - Path handling routines
|
Path - Path handling routines
|
||||||
-----------------------------
|
=============================
|
||||||
|
|
||||||
This module implements common routines for dealing with paths.
|
This module implements common routines for dealing with paths.
|
||||||
|
|
||||||
Functions
|
Functions
|
||||||
~~~~~~~~~
|
---------
|
||||||
|
|
||||||
`is_abspath()`::
|
`is_abspath()`::
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,18 +1,18 @@
|
||||||
Queue
|
Queue
|
||||||
-----
|
=====
|
||||||
|
|
||||||
Simple FIFO queue allowing enqueueing and dequeing from the start and end. +
|
Simple FIFO queue allowing enqueueing and dequeing from the start and end. +
|
||||||
This implementation only stores generic pointers to objects.
|
This implementation only stores generic pointers to objects.
|
||||||
So you must take care of the objects lifetime, size etc by yourself.
|
So you must take care of the objects lifetime, size etc by yourself.
|
||||||
|
|
||||||
Data structures
|
Data structures
|
||||||
~~~~~~~~~~~~~~~
|
---------------
|
||||||
|
|
||||||
* `queue_t`
|
* `queue_t`
|
||||||
An abstract datatype holding the queue, used by queue_* functions.
|
An abstract datatype holding the queue, used by queue_* functions.
|
||||||
|
|
||||||
Functions
|
Functions
|
||||||
~~~~~~~~~
|
---------
|
||||||
|
|
||||||
`queue_init()`::
|
`queue_init()`::
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,8 +1,8 @@
|
||||||
Red-Black Tree
|
Red-Black Tree
|
||||||
--------------
|
==============
|
||||||
|
|
||||||
Macros
|
Macros
|
||||||
~~~~~~
|
------
|
||||||
|
|
||||||
`RBTREE_INIT`::
|
`RBTREE_INIT`::
|
||||||
Initialize a `rbtree` structure. +
|
Initialize a `rbtree` structure. +
|
||||||
|
|
@ -15,7 +15,7 @@ rbtree tree = RBTREE_INIT(cmp);
|
||||||
will expand to set the compare function 'cmp' to the `cmp_fn` member.
|
will expand to set the compare function 'cmp' to the `cmp_fn` member.
|
||||||
|
|
||||||
Data structures
|
Data structures
|
||||||
~~~~~~~~~~~~~~~
|
---------------
|
||||||
|
|
||||||
* `rbtree`
|
* `rbtree`
|
||||||
+
|
+
|
||||||
|
|
@ -31,7 +31,7 @@ Structure that holds a tree of nodes
|
||||||
--
|
--
|
||||||
|
|
||||||
Functions
|
Functions
|
||||||
~~~~~~~~~
|
---------
|
||||||
|
|
||||||
`rbtree_insert()`::
|
`rbtree_insert()`::
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,9 +1,9 @@
|
||||||
String List
|
String List
|
||||||
-----------
|
===========
|
||||||
|
|
||||||
|
|
||||||
Data structures
|
Data structures
|
||||||
~~~~~~~~~~~~~~~
|
---------------
|
||||||
|
|
||||||
* `struct str_list`
|
* `struct str_list`
|
||||||
+
|
+
|
||||||
|
|
@ -18,7 +18,7 @@ Structure that holds the list
|
||||||
--
|
--
|
||||||
|
|
||||||
Functions
|
Functions
|
||||||
~~~~~~~~~
|
---------
|
||||||
|
|
||||||
`str_list_init`::
|
`str_list_init`::
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
String buffer API
|
String buffer API
|
||||||
-----------------
|
=================
|
||||||
|
|
||||||
First off, the major design choices. the most important thing to keep in mind
|
First off, the major design choices. the most important thing to keep in mind
|
||||||
when using the API is that it is designed for low-level usage, The basic error checking
|
when using the API is that it is designed for low-level usage, The basic error checking
|
||||||
|
|
@ -10,7 +10,7 @@ Other types of skipped error checking is for example if the ->len member is in r
|
||||||
the allocated block. (obviously this is checked in functions that may need to expand the memory)
|
the allocated block. (obviously this is checked in functions that may need to expand the memory)
|
||||||
|
|
||||||
Data structures
|
Data structures
|
||||||
~~~~~~~~~~~~~~~
|
---------------
|
||||||
|
|
||||||
* `strbuf_t`
|
* `strbuf_t`
|
||||||
|
|
||||||
|
|
@ -22,7 +22,7 @@ and it's possible to have embedded `NULL`'s because of that.
|
||||||
NOTE: ->alloc_size and ->len should *not* be messed with, only `strbuf_*` functions will know how to handle those properly.
|
NOTE: ->alloc_size and ->len should *not* be messed with, only `strbuf_*` functions will know how to handle those properly.
|
||||||
|
|
||||||
Functions
|
Functions
|
||||||
~~~~~~~~~
|
---------
|
||||||
|
|
||||||
`strbuf_setlen()`::
|
`strbuf_setlen()`::
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
xalloc - safe memory allocation
|
xalloc - safe memory allocation
|
||||||
-------------------------------
|
===============================
|
||||||
|
|
||||||
This module implements malloc and friends + some extensions.
|
This module implements malloc and friends + some extensions.
|
||||||
If `__DEBUG__` symbol is defined. The functions will provide extended
|
If `__DEBUG__` symbol is defined. The functions will provide extended
|
||||||
|
|
@ -10,7 +10,7 @@ some reason, this makes the need for client-code to check for `NULL` pointers re
|
||||||
by these functions redundant.
|
by these functions redundant.
|
||||||
|
|
||||||
Functions
|
Functions
|
||||||
~~~~~~~~~
|
---------
|
||||||
|
|
||||||
`xmalloc()`::
|
`xmalloc()`::
|
||||||
|
|
||||||
|
|
|
||||||
Reference in a new issue