summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_set_root.2
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/nvme_set_root.2')
-rw-r--r--doc/man/nvme_set_root.216
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/man/nvme_set_root.2 b/doc/man/nvme_set_root.2
new file mode 100644
index 0000000..78ca543
--- /dev/null
+++ b/doc/man/nvme_set_root.2
@@ -0,0 +1,16 @@
+.TH "nvme_set_root" 9 "nvme_set_root" "December 2023" "libnvme API manual" LINUX
+.SH NAME
+nvme_set_root \- Set nvme_root_t context
+.SH SYNOPSIS
+.B "void" nvme_set_root
+.BI "(nvme_root_t r " ");"
+.SH ARGUMENTS
+.IP "r" 12
+nvme_root_t context
+.SH "DESCRIPTION"
+In order to be able to log from code paths where no root object is passed in
+via the arguments use the the default one which can be set via this call.
+When creating a new root object with \fInvme_create_root\fP the global root object
+will be set as well. This means the global root object is always pointing to
+the latest created root object. Note the first \fInvme_free_tree\fP call will reset
+the global root object.