diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-05-05 11:05:25 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-05-05 11:05:25 +0000 |
commit | d3b6c0269abf2332f6f4b43760524b040ca58ff8 (patch) | |
tree | 6a0ebdb4cb3c7b76c824f021d9f3624d16037457 /doc/rst/log.rst | |
parent | Adding upstream version 1.8. (diff) | |
download | libnvme-upstream/1.9.tar.xz libnvme-upstream/1.9.zip |
Adding upstream version 1.9.upstream/1.9
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r-- | doc/rst/log.rst | 59 |
1 files changed, 59 insertions, 0 deletions
diff --git a/doc/rst/log.rst b/doc/rst/log.rst index 67911a5..edbb330 100644 --- a/doc/rst/log.rst +++ b/doc/rst/log.rst @@ -28,6 +28,32 @@ logging functions Sets the default logging variables for the library. +.. c:function:: int nvme_get_logging_level (nvme_root_t r, bool *log_pid, bool *log_tstamp) + + Get current logging level + +**Parameters** + +``nvme_root_t r`` + nvme_root_t context + +``bool *log_pid`` + Pointer to store a current value of logging of + the PID flag at (optional). + +``bool *log_tstamp`` + Pointer to store a current value of logging of + the timestamp flag at (optional). + +**Description** + +Retrieves current values of logging variables. + +**Return** + +current log level value or DEFAULT_LOGLEVEL if not initialized. + + .. c:function:: void nvme_set_root (nvme_root_t r) Set nvme_root_t context @@ -47,3 +73,36 @@ the latest created root object. Note the first **nvme_free_tree** call will rese the global root object. +.. c:function:: void nvme_set_debug (bool debug) + + Set NVMe command debugging output + +**Parameters** + +``bool debug`` + true to enable or false to disable + +**Description** + +Don't use it, it's debricated. + + +.. c:function:: bool nvme_get_debug (void) + + Get NVMe command debugging output + +**Parameters** + +``void`` + no arguments + +**Description** + + +Don't use it, it's debricated. + +**Return** + +false if disabled or true if enabled. + + |