diff mbox

[v2,06/11] blockjobs: fix documentation

Message ID 1475272849-19990-7-git-send-email-jsnow@redhat.com (mailing list archive)
State New, archived
Headers show

Commit Message

John Snow Sept. 30, 2016, 10 p.m. UTC
Wrong function names in documentation.

Signed-off-by: John Snow <jsnow@redhat.com>
---
 include/block/blockjob_int.h | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

Comments

Kevin Wolf Oct. 5, 2016, 3:03 p.m. UTC | #1
Am 01.10.2016 um 00:00 hat John Snow geschrieben:
> Wrong function names in documentation.
> 
> Signed-off-by: John Snow <jsnow@redhat.com>
> ---
>  include/block/blockjob_int.h | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/include/block/blockjob_int.h b/include/block/blockjob_int.h
> index 0a2d41e..c6da7e4 100644
> --- a/include/block/blockjob_int.h
> +++ b/include/block/blockjob_int.h
> @@ -305,7 +305,7 @@ void block_job_enter(BlockJob *job);
>  void block_job_event_cancelled(BlockJob *job);
>  
>  /**
> - * block_job_ready:
> + * block_job_event_completed:

Yes...

>   * @job: The job which is now ready to complete.

...that was half of the fix.

>   * @msg: Error message. Only present on failure.
>   *

Kevin
John Snow Oct. 5, 2016, 4:22 p.m. UTC | #2
On 10/05/2016 11:03 AM, Kevin Wolf wrote:
> Am 01.10.2016 um 00:00 hat John Snow geschrieben:
>> Wrong function names in documentation.
>>
>> Signed-off-by: John Snow <jsnow@redhat.com>
>> ---
>>  include/block/blockjob_int.h | 6 +++---
>>  1 file changed, 3 insertions(+), 3 deletions(-)
>>
>> diff --git a/include/block/blockjob_int.h b/include/block/blockjob_int.h
>> index 0a2d41e..c6da7e4 100644
>> --- a/include/block/blockjob_int.h
>> +++ b/include/block/blockjob_int.h
>> @@ -305,7 +305,7 @@ void block_job_enter(BlockJob *job);
>>  void block_job_event_cancelled(BlockJob *job);
>>
>>  /**
>> - * block_job_ready:
>> + * block_job_event_completed:
>
> Yes...
>
>>   * @job: The job which is now ready to complete.
>
> ...that was half of the fix.
>

:(

>>   * @msg: Error message. Only present on failure.
>>   *
>
> Kevin
>

I'm sorry for not double-checking this one.
diff mbox

Patch

diff --git a/include/block/blockjob_int.h b/include/block/blockjob_int.h
index 0a2d41e..c6da7e4 100644
--- a/include/block/blockjob_int.h
+++ b/include/block/blockjob_int.h
@@ -305,7 +305,7 @@  void block_job_enter(BlockJob *job);
 void block_job_event_cancelled(BlockJob *job);
 
 /**
- * block_job_ready:
+ * block_job_event_completed:
  * @job: The job which is now ready to complete.
  * @msg: Error message. Only present on failure.
  *
@@ -314,8 +314,8 @@  void block_job_event_cancelled(BlockJob *job);
 void block_job_event_completed(BlockJob *job, const char *msg);
 
 /**
- * block_job_ready:
- * @job: The job which is now ready to complete.
+ * block_job_event_ready:
+ * @job: The job which is now ready to be completed.
  *
  * Send a BLOCK_JOB_READY event for the specified job.
  */