ivampiresp/Spdk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

nvme: fix typo in zone append header documentation

Browse Source 
While zone append is very similar to write, we should refer
to the proper I/O command.

Signed-off-by: Niklas Cassel <niklas.cassel@wdc.com>
Change-Id: I85dc2634eefb502dd38351ca02d9b09a15c5620f
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/6245
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Paul Luse <paul.e.luse@intel.com>
Reviewed-by: Aleksey Marchuk <alexeymar@mellanox.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Reviewed-by: Ben Walker <benjamin.walker@intel.com>
Community-CI: Mellanox Build Bot
This commit is contained in:
Niklas Cassel 2021-02-03 13:42:39 +00:00 committed by Tomasz Zawadzki
parent 1c6277b21b
commit c56fb6d3ee
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
include/spdk/nvme_zns.h
View File

@ -114,11 +114,11 @@ uint32_t spdk_nvme_zns_ctrlr_get_max_zone_append_size(const struct spdk_nvme_ctr
* The user must ensure that only one thread submits I/O on a given qpair at any * The user must ensure that only one thread submits I/O on a given qpair at any
* given time. * given time.
* *
* \param ns NVMe namespace to submit the write I/O. * \param ns NVMe namespace to submit the zone append I/O.
* \param qpair I/O queue pair to submit the request. * \param qpair I/O queue pair to submit the request.
* \param buffer Virtual address pointer to the data payload buffer. * \param buffer Virtual address pointer to the data payload buffer.
* \param zslba Zone Start LBA of the zone that we are appending to. * \param zslba Zone Start LBA of the zone that we are appending to.
* \param lba_count Length (in sectors) for the write operation. * \param lba_count Length (in sectors) for the zone append operation.
* \param cb_fn Callback function to invoke when the I/O is completed. * \param cb_fn Callback function to invoke when the I/O is completed.
* \param cb_arg Argument to pass to the callback function. * \param cb_arg Argument to pass to the callback function.
* \param io_flags Set flags, defined by the SPDK_NVME_IO_FLAGS_* entries in * \param io_flags Set flags, defined by the SPDK_NVME_IO_FLAGS_* entries in
@ -141,13 +141,13 @@ int spdk_nvme_zns_zone_append(struct spdk_nvme_ns *ns, struct spdk_nvme_qpair *q
* The user must ensure that only one thread submits I/O on a given qpair at any * The user must ensure that only one thread submits I/O on a given qpair at any
* given time. * given time.
* *
* \param ns NVMe namespace to submit the write I/O. * \param ns NVMe namespace to submit the zone append I/O.
* \param qpair I/O queue pair to submit the request. * \param qpair I/O queue pair to submit the request.
* \param buffer Virtual address pointer to the data payload buffer. * \param buffer Virtual address pointer to the data payload buffer.
* \param metadata Virtual address pointer to the metadata payload, the length * \param metadata Virtual address pointer to the metadata payload, the length
* of metadata is specified by spdk_nvme_ns_get_md_size(). * of metadata is specified by spdk_nvme_ns_get_md_size().
* \param zslba Zone Start LBA of the zone that we are appending to. * \param zslba Zone Start LBA of the zone that we are appending to.
* \param lba_count Length (in sectors) for the write operation. * \param lba_count Length (in sectors) for the zone append operation.
* \param cb_fn Callback function to invoke when the I/O is completed. * \param cb_fn Callback function to invoke when the I/O is completed.
* \param cb_arg Argument to pass to the callback function. * \param cb_arg Argument to pass to the callback function.
* \param io_flags Set flags, defined by the SPDK_NVME_IO_FLAGS_* entries in * \param io_flags Set flags, defined by the SPDK_NVME_IO_FLAGS_* entries in