Commit 62bfdf0c authored by John Snow's avatar John Snow Committed by Kevin Wolf
Browse files

Blockjobs: documentation touchup 



Trivial; Document what the job creation flags do,
and some general tidying.

Signed-off-by: default avatarJohn Snow <jsnow@redhat.com>
Signed-off-by: default avatarKevin Wolf <kwolf@redhat.com>
parent 75859b94

include/block/blockjob.h

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

include/block/blockjob_int.h

+3 −1
Original line number Diff line number Diff line
@@ -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.