summaryrefslogtreecommitdiffstats
path: root/doc/rst/log.rst
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--doc/rst/log.rst30
1 files changed, 30 insertions, 0 deletions
diff --git a/doc/rst/log.rst b/doc/rst/log.rst
new file mode 100644
index 0000000..45b4689
--- /dev/null
+++ b/doc/rst/log.rst
@@ -0,0 +1,30 @@
+.. _log.h:
+
+**log.h**
+
+
+logging functions
+
+.. c:function:: void nvme_init_logging (nvme_root_t r, int lvl, bool log_pid, bool log_tstamp)
+
+ Initialize logging
+
+**Parameters**
+
+``nvme_root_t r``
+ nvme_root_t context
+
+``int lvl``
+ Logging level to set
+
+``bool log_pid``
+ Boolean to enable logging of the PID
+
+``bool log_tstamp``
+ Boolean to enable logging of the timestamp
+
+**Description**
+
+Sets the default logging variables for the library.
+
+