diff mbox series

[FFmpeg-devel,v3] lavu/opt: Clarify the scope of AVOptions

Message ID 20240424073028.565112-1-ffmpeg-devel@pileofstuff.org
State Accepted
Commit 99e43a6dfecbc170192d3229a725cc963c6e7c15
Headers show
Series [FFmpeg-devel,v3] lavu/opt: Clarify the scope of AVOptions | expand

Checks

Context Check Description
yinshiyou/make_loongarch64 success Make finished
yinshiyou/make_fate_loongarch64 success Make fate finished

Commit Message

Andrew Sayers April 24, 2024, 7:30 a.m. UTC
See discussion on the mailing list:
https://ffmpeg.org/pipermail/ffmpeg-devel/2024-April/326054.html
---
 libavutil/opt.h | 10 ++++++++++
 1 file changed, 10 insertions(+)

Comments

Michael Niedermayer April 30, 2024, 11:33 p.m. UTC | #1
On Wed, Apr 24, 2024 at 08:30:28AM +0100, Andrew Sayers wrote:
> See discussion on the mailing list:
> https://ffmpeg.org/pipermail/ffmpeg-devel/2024-April/326054.html
> ---
>  libavutil/opt.h | 10 ++++++++++
>  1 file changed, 10 insertions(+)
> 
> diff --git a/libavutil/opt.h b/libavutil/opt.h
> index e6013662f6..6cf2b39a63 100644
> --- a/libavutil/opt.h
> +++ b/libavutil/opt.h
> @@ -53,6 +53,16 @@
>   * question is allowed to access the field. This allows us to extend the
>   * semantics of those fields without breaking API compatibility.
>   *
> + * @section avoptions_scope Scope of AVOptions
> + *
> + * AVOptions is designed to support any set of multimedia configuration options
> + * that can be defined at compile-time.  Although it is mainly used to expose
> + * FFmpeg options, you are welcome to adapt it to your own use case.
> + *
> + * No single approach can ever fully solve the problem of configuration,
> + * but please submit a patch if you believe you have found a problem
> + * that is best solved by extending AVOptions.
> + *
>   * @section avoptions_implement Implementing AVOptions
>   * This section describes how to add AVOptions capabilities to a struct.
>   *

will apply

thx

[...]
diff mbox series

Patch

diff --git a/libavutil/opt.h b/libavutil/opt.h
index e6013662f6..6cf2b39a63 100644
--- a/libavutil/opt.h
+++ b/libavutil/opt.h
@@ -53,6 +53,16 @@ 
  * question is allowed to access the field. This allows us to extend the
  * semantics of those fields without breaking API compatibility.
  *
+ * @section avoptions_scope Scope of AVOptions
+ *
+ * AVOptions is designed to support any set of multimedia configuration options
+ * that can be defined at compile-time.  Although it is mainly used to expose
+ * FFmpeg options, you are welcome to adapt it to your own use case.
+ *
+ * No single approach can ever fully solve the problem of configuration,
+ * but please submit a patch if you believe you have found a problem
+ * that is best solved by extending AVOptions.
+ *
  * @section avoptions_implement Implementing AVOptions
  * This section describes how to add AVOptions capabilities to a struct.
  *