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

[Benoît Canet]

The Monday 02 Jun 2014 à 22:15:21 (+0200), 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 <address@hidden>
> Reported-by: Markus Armbruster <address@hidden>
> Reviewed-by: Eric Blake <address@hidden>
> ---
> v2: Fixed spelling mistakes [Eric]
> ---
>  qemu-img.c    |  9 +++++----
>  qemu-img.texi | 23 +++++++++++++++++++++++
>  2 files changed, 28 insertions(+), 4 deletions(-)
> 
> diff --git a/qemu-img.c b/qemu-img.c
> index b3d2bc6..aa89ba2 100644
> --- a/qemu-img.c
> +++ b/qemu-img.c
> @@ -580,10 +580,11 @@ static int collect_image_check(BlockDriverState *bs,
>  /*
>   * Checks an image for consistency. Exit codes:
>   *
> - * 0 - Check completed, image is good
> - * 1 - Check not completed because of internal errors
> - * 2 - Check completed, image is corrupted
> - * 3 - Check completed, image has leaked clusters, but is good otherwise
> + *  0 - Check completed, image is good
> + *  1 - Check not completed because of internal errors
> + *  2 - Check completed, image is corrupted
> + *  3 - Check completed, image has leaked clusters, but is good otherwise
> + * 63 - Checks are not supported by the image format
>   */
>  static int img_check(int argc, char **argv)
>  {
> diff --git a/qemu-img.texi b/qemu-img.texi
> index f84590e..c68b541 100644
> --- a/qemu-img.texi
> +++ b/qemu-img.texi
> @@ -126,6 +126,29 @@ wrong fix or hiding corruption that has already occurred.
>  Only the formats @code{qcow2}, @code{qed} and @code{vdi} support
>  consistency checks.
>  
> +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
> +occurred. The following table summarizes all exit codes of the check 
> subcommand:
> +
> address@hidden @option
> +
> address@hidden 0
> +Check completed, the image is (now) consistent
> address@hidden 1
> +Check not completed because of internal errors
> address@hidden 2
> +Check completed, image is corrupted
> address@hidden 3
> +Check completed, image has leaked clusters, but is not corrupted
> address@hidden 63
> +Checks are not supported by the image format
> +
> address@hidden table
> +
> +If @code{-r} is specified, exit codes representing the image state refer to 
> the
> +state after (the attempt at) repairing it. That is, a successful @code{-r 
> all}
> +will yield the exit code 0, independently of the image state before.
> +
>  @item create [-f @var{fmt}] [-o @var{options}] @var{filename} address@hidden
>  
>  Create the new disk image @var{filename} of size @var{size} and format
> -- 
> 1.9.3
> 
> 
Reviewed-by: Benoit Canet <address@hidden>