lib: fix typos
[dpdk.git] / lib / librte_jobstats / rte_jobstats.h
index de6a89a..e159156 100644 (file)
@@ -85,7 +85,7 @@ struct rte_jobstats {
        /**< Minimum execute time. */
 
        uint64_t max_exec_time;
-       /**< Minimum execute time. */
+       /**< Maximum execute time. */
 
        uint64_t exec_cnt;
        /**< Execute count. */
@@ -98,7 +98,7 @@ struct rte_jobstats {
 } __rte_cache_aligned;
 
 struct rte_jobstats_context {
-       /** Viariable holding time at different points:
+       /** Variable holding time at different points:
         * -# loop start time if loop was started but no job executed yet.
         * -# job start time if job is currently executing.
         * -# job finish time if job finished its execution.
@@ -117,7 +117,7 @@ struct rte_jobstats_context {
        /**< Minimum loop execute time. */
 
        uint64_t max_exec_time;
-       /**< Minimum loop execute time. */
+       /**< Maximum loop execute time. */
 
        /**
         * Sum of time that is not the execute time (ex: from job finish to next
@@ -236,6 +236,20 @@ rte_jobstats_set_target(struct rte_jobstats *job, int64_t target);
 int
 rte_jobstats_start(struct rte_jobstats_context *ctx, struct rte_jobstats *job);
 
+/**
+ * Mark that *job* finished its execution, but time of this work will be skipped
+ * and added to management time.
+ *
+ * @param job
+ *  Job object.
+ *
+ * @return
+ *  0 on success
+ *  -EINVAL if job is NULL or job was not started (it have no context).
+ */
+int
+rte_jobstats_abort(struct rte_jobstats *job);
+
 /**
  * Mark that *job* finished its execution. Context in which it was executing
  * will receive stat update. After this function call *job* object is ready to
@@ -299,7 +313,7 @@ rte_jobstats_set_max(struct rte_jobstats *job, uint64_t period);
  *
  * @param job
  *  Job object.
- * @param update_pedriod_cb
+ * @param update_period_cb
  *  Callback to set. If NULL restore default update function.
  */
 void