summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_ns_mgmt_delete.2
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/nvme_ns_mgmt_delete.2')
-rw-r--r--doc/man/nvme_ns_mgmt_delete.219
1 files changed, 19 insertions, 0 deletions
diff --git a/doc/man/nvme_ns_mgmt_delete.2 b/doc/man/nvme_ns_mgmt_delete.2
new file mode 100644
index 0000000..3d813e6
--- /dev/null
+++ b/doc/man/nvme_ns_mgmt_delete.2
@@ -0,0 +1,19 @@
+.TH "nvme_ns_mgmt_delete" 9 "nvme_ns_mgmt_delete" "January 2023" "libnvme API manual" LINUX
+.SH NAME
+nvme_ns_mgmt_delete \- Delete a non attached namespace
+.SH SYNOPSIS
+.B "int" nvme_ns_mgmt_delete
+.BI "(int fd " ","
+.BI "__u32 nsid " ");"
+.SH ARGUMENTS
+.IP "fd" 12
+File descriptor of nvme device
+.IP "nsid" 12
+Namespace identifier to delete
+.SH "DESCRIPTION"
+It is recommended that a namespace being deleted is not attached to any
+controller. Use the \fBnvme_ns_detach_ctrls\fP first if the namespace is still
+attached.
+.SH "RETURN"
+The nvme command status if a response was received (see
+\fIenum nvme_status_field\fP) or -1 with errno set otherwise.