Commit c56fb6d3 authored by Niklas Cassel's avatar Niklas Cassel Committed by Tomasz Zawadzki
Browse files

nvme: fix typo in zone append header documentation 



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

Signed-off-by: default avatarNiklas Cassel <niklas.cassel@wdc.com>
Change-Id: I85dc2634eefb502dd38351ca02d9b09a15c5620f
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/6245


Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: default avatarPaul Luse <paul.e.luse@intel.com>
Reviewed-by: default avatarAleksey Marchuk <alexeymar@mellanox.com>
Reviewed-by: default avatarJim Harris <james.r.harris@intel.com>
Reviewed-by: default avatarBen Walker <benjamin.walker@intel.com>
Community-CI: Mellanox Build Bot
parent 1c6277b2

include/spdk/nvme_zns.h

+4 −4
Original line number Diff line number Diff line
@@ -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

 * 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 buffer Virtual address pointer to the data payload buffer.

 * \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_arg Argument to pass to the callback function.

 * \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

 * 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 buffer Virtual address pointer to the data payload buffer.

 * \param metadata Virtual address pointer to the metadata payload, the length

 * 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 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_arg Argument to pass to the callback function.

 * \param io_flags Set flags, defined by the SPDK_NVME_IO_FLAGS_* entries in