Re: [Qemu-devel] [PATCH] qemu-img: Document check exit codes

[Max Reitz <mreitz@redhat.com>]

On 02.06.2014 21:45, Eric Blake wrote:
> On 06/02/2014 01:31 PM, Max Reitz wrote:
>> The exit code 63 (check not supported by image format) was not even
>> documented in the comment above the check command in the source code;
>> add it, as it does indeed seem useful.
>>
>> Also, document all of check's exit codes in the manpage.
>>
>> Signed-off-by: Max Reitz <mreitz@redhat.com>
>> Reported-by: Markus Armbruster <armbru@redhat.com>
>> ---
>>   qemu-img.c    |  9 +++++----
>>   qemu-img.texi | 23 +++++++++++++++++++++++
>>   2 files changed, 28 insertions(+), 4 deletions(-)
>>   
>> +In case the image does not have any inconsistencies, check exits with @code{0}.
>> +Other exit codes indicate the kind of inconsistency found or if another error
>> +occured. The following table summarizes all exit codes of the check subcommand:
> s/occured/occurred/

It's a bit embarrassing that the correct spelling was even part of the 
hunk environment. :-)

>> +
>> +If @code{-r} is specified, exit codes representing the image state refer to the
>> +state after (the attempt on) repairing it. That is, a successful @code{-r all}
> Not sure if this reads better, but:

Yes, the sentence is kind of hard to read, but I couldn't think of a 
nicer expression (I could drop the "representing the image state" part, 
but then people might ask how this applies to code 63 -- but then again, 
it just doesn't make any sense for that code, so...). That's why I added 
the explanatory example following it.

> s/attempt on/attempt at/
>
> With the spelling fix,
> Reviewed-by: Eric Blake <eblake@redhat.com>

Thank you,

Max