[FFmpeg-devel] [PATCH v2] doc/developer: origin of tables should be documented.

[Tomas Härdin]

lör 2020-08-08 klockan 19:57 +0200 skrev Nicolas George:
> diff --git a/doc/developer.texi b/doc/developer.texi
> index b33cab0fc7..c3103f31dc 100644
> --- a/doc/developer.texi
> +++ b/doc/developer.texi
> @@ -216,6 +216,14 @@ please use av_log() instead.
>  @item
>  Casts should be used only when necessary. Unneeded parentheses
>  should also be avoided if they don't make the code easier to understand.
> +
> + at item
> +If the code contains tables of numbers or other data, their origin should be
> +documented in a comment, so that other developers can rebuild them if
> +necessary. If they were taken from a reference, include the URL of that
> +reference. If they were computed by a tool, include the code of the tool.
> +If they were reverse-engineered, include an honest attempt at explaining the
> +methods used.

Look OK to me beyond the possible RE issues which have already been
highlighted. I try to put references to the relevant SMPTE spec and
section/table number whenever I make changes to mxf*, but of course no
one's perfect.

/Tomas