Commit d83ccf43 authored Jul 04, 2024 by Konrad Sztyber Committed by Tomasz Zawadzki Jul 09, 2024

accel: clarify the usage of spdk_accel_sequence_abort()



The description didn't mention that this function can only be used
before executing a sequence.

Reported-by: Jacek Kalwas <jacek.kalwas@intel.com>
Signed-off-by: Konrad Sztyber <konrad.sztyber@intel.com>
Change-Id: Ibbb91fcce7449bb1eb96ed0ae5318c2ea96aaee9
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/24055


Community-CI: Mellanox Build Bot
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Jacek Kalwas <jacek.kalwas@intel.com>
Reviewed-by: Aleksey Marchuk <alexeymar@nvidia.com>
Reviewed-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com>

parent f282c995

include/spdk/accel.h

+2 −1

Original line number	Diff line number	Diff line
		@@ -683,7 +683,8 @@ void spdk_accel_sequence_reverse(struct spdk_accel_sequence *seq);

		/**
		* Abort a sequence. This will execute the completion callbacks of all operations that were added
		* to the sequence and will then free the sequence object.
		* to the sequence and will then free the sequence object. This function can only be used before a
		* sequence is executed, i.e. before calling `spdk_accel_sequence_finish()`.
		*
		* \param seq Sequence to abort.
		*/