[FFmpeg-devel] [PATCH] Misc error.h cosmetical patches

[Stefano Sabatini]

On date Saturday 2010-03-13 15:42:13 +0100, Stefano Sabatini encoded:
> Hi, as in subject.
> -- 
> FFmpeg = Frightening and Furious Mastodontic Practical EnGraver

> From 053e983d4ca239794019bce2557f561e990326aa Mon Sep 17 00:00:00 2001
> From: Stefano Sabatini <stefano.sabatini-lala at poste.it>
> Date: Sat, 13 Mar 2010 15:33:28 +0100
> Subject: [PATCH 1/3] Prefer ///< doxygen inline syntax over /**< ... */.
> 
> ---
>  libavutil/error.h |   20 ++++++++++----------
>  1 files changed, 10 insertions(+), 10 deletions(-)
> 
> diff --git a/libavutil/error.h b/libavutil/error.h
> index a386c1f..d2cd740 100644
> --- a/libavutil/error.h
> +++ b/libavutil/error.h
> @@ -33,15 +33,15 @@
>  #define AVERROR(e) (e)
>  #define AVUNERROR(e) (e)
>  #endif
> -#define AVERROR_UNKNOWN     AVERROR(EINVAL)  /**< unknown error */
> -#define AVERROR_IO          AVERROR(EIO)     /**< I/O error */
> -#define AVERROR_NUMEXPECTED AVERROR(EDOM)    /**< Number syntax expected in filename. */
> -#define AVERROR_INVALIDDATA AVERROR(EINVAL)  /**< invalid data found */
> -#define AVERROR_NOMEM       AVERROR(ENOMEM)  /**< not enough memory */
> -#define AVERROR_NOFMT       AVERROR(EILSEQ)  /**< unknown format */
> -#define AVERROR_NOTSUPP     AVERROR(ENOSYS)  /**< Operation not supported. */
> -#define AVERROR_NOENT       AVERROR(ENOENT)  /**< No such file or directory. */
> -#define AVERROR_EOF         AVERROR(EPIPE)   /**< End of file. */
> -#define AVERROR_PATCHWELCOME    (-MKTAG('P','A','W','E')) /**< Not yet implemented in FFmpeg. Patches welcome. */
> +#define AVERROR_UNKNOWN     AVERROR(EINVAL)  ///< unknown error
> +#define AVERROR_IO          AVERROR(EIO)     ///< I/O error
> +#define AVERROR_NUMEXPECTED AVERROR(EDOM)    ///< Number syntax expected in filename.
> +#define AVERROR_INVALIDDATA AVERROR(EINVAL)  ///< invalid data found
> +#define AVERROR_NOMEM       AVERROR(ENOMEM)  ///< not enough memory
> +#define AVERROR_NOFMT       AVERROR(EILSEQ)  ///< unknown format
> +#define AVERROR_NOTSUPP     AVERROR(ENOSYS)  ///< Operation not supported.
> +#define AVERROR_NOENT       AVERROR(ENOENT)  ///< No such file or directory.
> +#define AVERROR_EOF         AVERROR(EPIPE)   ///< End of file.
> +#define AVERROR_PATCHWELCOME    (-MKTAG('P','A','W','E')) ///< Not yet implemented in FFmpeg. Patches welcome.
>  
>  #endif /* AVUTIL_ERROR_H */
> -- 
> 1.6.6.1
> 

> From 87b946832ffb62ef407d339ae40defe866047102 Mon Sep 17 00:00:00 2001
> From: Stefano Sabatini <stefano.sabatini-lala at poste.it>
> Date: Sat, 13 Mar 2010 15:35:03 +0100
> Subject: [PATCH 2/3] Add a notice clarifying the difference between AVERROR(XXX) and
>  AVERROR_XXX error codes.
> 
> ---
>  libavutil/error.h |    2 ++
>  1 files changed, 2 insertions(+), 0 deletions(-)
> 
> diff --git a/libavutil/error.h b/libavutil/error.h
> index d2cd740..a7543cb 100644
> --- a/libavutil/error.h
> +++ b/libavutil/error.h
> @@ -42,6 +42,8 @@
>  #define AVERROR_NOTSUPP     AVERROR(ENOSYS)  ///< Operation not supported.
>  #define AVERROR_NOENT       AVERROR(ENOENT)  ///< No such file or directory.
>  #define AVERROR_EOF         AVERROR(EPIPE)   ///< End of file.
> +
> +/* FFmpeg specific error codes */
>  #define AVERROR_PATCHWELCOME    (-MKTAG('P','A','W','E')) ///< Not yet implemented in FFmpeg. Patches welcome.
>  
>  #endif /* AVUTIL_ERROR_H */
> -- 
> 1.6.6.1
> 

> From cac19ec993fc2a7a45498540c45cd5b5f961c385 Mon Sep 17 00:00:00 2001
> From: Stefano Sabatini <stefano.sabatini-lala at poste.it>
> Date: Sat, 13 Mar 2010 15:39:10 +0100
> Subject: [PATCH 3/3] Use punctuation rules consistent with those defined in POSIX error.h
>  file.
> 
> ---
>  libavutil/error.h |   18 +++++++++---------
>  1 files changed, 9 insertions(+), 9 deletions(-)
> 
> diff --git a/libavutil/error.h b/libavutil/error.h
> index a7543cb..cbb1ce5 100644
> --- a/libavutil/error.h
> +++ b/libavutil/error.h
> @@ -33,17 +33,17 @@
>  #define AVERROR(e) (e)
>  #define AVUNERROR(e) (e)
>  #endif
> -#define AVERROR_UNKNOWN     AVERROR(EINVAL)  ///< unknown error
> +#define AVERROR_UNKNOWN     AVERROR(EINVAL)  ///< Unknown error
>  #define AVERROR_IO          AVERROR(EIO)     ///< I/O error
> -#define AVERROR_NUMEXPECTED AVERROR(EDOM)    ///< Number syntax expected in filename.
> -#define AVERROR_INVALIDDATA AVERROR(EINVAL)  ///< invalid data found
> -#define AVERROR_NOMEM       AVERROR(ENOMEM)  ///< not enough memory
> -#define AVERROR_NOFMT       AVERROR(EILSEQ)  ///< unknown format
> -#define AVERROR_NOTSUPP     AVERROR(ENOSYS)  ///< Operation not supported.
> -#define AVERROR_NOENT       AVERROR(ENOENT)  ///< No such file or directory.
> -#define AVERROR_EOF         AVERROR(EPIPE)   ///< End of file.
> +#define AVERROR_NUMEXPECTED AVERROR(EDOM)    ///< Number syntax expected in filename
> +#define AVERROR_INVALIDDATA AVERROR(EINVAL)  ///< Invalid data found
> +#define AVERROR_NOMEM       AVERROR(ENOMEM)  ///< Not enough memory
> +#define AVERROR_NOFMT       AVERROR(EILSEQ)  ///< Unknown format
> +#define AVERROR_NOTSUPP     AVERROR(ENOSYS)  ///< Operation not supported
> +#define AVERROR_NOENT       AVERROR(ENOENT)  ///< No such file or directory
> +#define AVERROR_EOF         AVERROR(EPIPE)   ///< End of file
>  
>  /* FFmpeg specific error codes */
> -#define AVERROR_PATCHWELCOME    (-MKTAG('P','A','W','E')) ///< Not yet implemented in FFmpeg. Patches welcome.
> +#define AVERROR_PATCHWELCOME    (-MKTAG('P','A','W','E')) ///< Not yet implemented in FFmpeg, patches welcome
>  
>  #endif /* AVUTIL_ERROR_H */
> -- 
> 1.6.6.1

I'll apply them in three days if there are no objections, regards.
-- 
FFmpeg = Fucking and Freak Multimedia Pitiful Ecumenical Guru