diff options
| author | John Snow <jsnow@redhat.com> | 2018-03-10 03:27:28 -0500 |
|---|---|---|
| committer | Kevin Wolf <kwolf@redhat.com> | 2018-03-19 12:01:24 +0100 |
| commit | 62bfdf0ca1228c4af765388fb248c0e6db1d2a12 (patch) | |
| tree | 1b3cf9f2d9f9e4cd75fb6d6f513bf05a301647d9 /include | |
| parent | 75859b9420906f72c1c6d6273481ff30c141dbd5 (diff) | |
Blockjobs: documentation touchup
Trivial; Document what the job creation flags do,
and some general tidying.
Signed-off-by: John Snow <jsnow@redhat.com>
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
Diffstat (limited to 'include')
| -rw-r--r-- | include/block/blockjob.h | 8 | ||||
| -rw-r--r-- | include/block/blockjob_int.h | 4 |
2 files changed, 7 insertions, 5 deletions
diff --git a/include/block/blockjob.h b/include/block/blockjob.h index 29cde3ffe3..b77fac118d 100644 --- a/include/block/blockjob.h +++ b/include/block/blockjob.h @@ -127,12 +127,10 @@ typedef struct BlockJob { /** Reference count of the block job */ int refcnt; - /* True if this job has reported completion by calling block_job_completed. - */ + /** True when job has reported completion by calling block_job_completed. */ bool completed; - /* ret code passed to block_job_completed. - */ + /** ret code passed to block_job_completed. */ int ret; /** @@ -146,7 +144,9 @@ typedef struct BlockJob { } BlockJob; typedef enum BlockJobCreateFlags { + /* Default behavior */ BLOCK_JOB_DEFAULT = 0x00, + /* BlockJob is not QMP-created and should not send QMP events */ BLOCK_JOB_INTERNAL = 0x01, } BlockJobCreateFlags; diff --git a/include/block/blockjob_int.h b/include/block/blockjob_int.h index becaae74c2..259d49b32a 100644 --- a/include/block/blockjob_int.h +++ b/include/block/blockjob_int.h @@ -114,11 +114,13 @@ struct BlockJobDriver { * block_job_create: * @job_id: The id of the newly-created job, or %NULL to have one * generated automatically. - * @job_type: The class object for the newly-created job. + * @driver: The class object for the newly-created job. * @txn: The transaction this job belongs to, if any. %NULL otherwise. * @bs: The block * @perm, @shared_perm: Permissions to request for @bs * @speed: The maximum speed, in bytes per second, or 0 for unlimited. + * @flags: Creation flags for the Block Job. + * See @BlockJobCreateFlags * @cb: Completion function for the job. * @opaque: Opaque pointer value passed to @cb. * @errp: Error object. |