summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_host_set_pdc_enabled.2
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2023-01-31 04:16:55 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2023-01-31 04:16:55 +0000
commitfbe661f56f8f51c8bda7b3ced1ec41af509e61ff (patch)
treeac8ac7d3960922094733bac6d9a5300da7171c56 /doc/man/nvme_host_set_pdc_enabled.2
parentAdding upstream version 1.2. (diff)
downloadlibnvme-fbe661f56f8f51c8bda7b3ced1ec41af509e61ff.tar.xz
libnvme-fbe661f56f8f51c8bda7b3ced1ec41af509e61ff.zip
Adding upstream version 1.3.upstream/1.3
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/man/nvme_host_set_pdc_enabled.2')
-rw-r--r--doc/man/nvme_host_set_pdc_enabled.216
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/man/nvme_host_set_pdc_enabled.2 b/doc/man/nvme_host_set_pdc_enabled.2
new file mode 100644
index 0000000..cede6d6
--- /dev/null
+++ b/doc/man/nvme_host_set_pdc_enabled.2
@@ -0,0 +1,16 @@
+.TH "nvme_host_set_pdc_enabled" 9 "nvme_host_set_pdc_enabled" "January 2023" "libnvme API manual" LINUX
+.SH NAME
+nvme_host_set_pdc_enabled \- Set Persistent Discovery Controller flag
+.SH SYNOPSIS
+.B "void" nvme_host_set_pdc_enabled
+.BI "(nvme_host_t h " ","
+.BI "bool enabled " ");"
+.SH ARGUMENTS
+.IP "h" 12
+Host for which the falg should be set
+.IP "enabled" 12
+The bool to set the enabled flag
+.SH "DESCRIPTION"
+When \fBnvme_host_set_pdc_enabled\fP is not used to set the PDC flag,
+\fBnvme_host_is_pdc_enabled\fP will return the default value which was
+passed into the function and not the undefined flag value.