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

Jean-Baptiste Kempf jb at videolan.org
Mon Aug 10 18:34:49 EEST 2020

On Sat, 8 Aug 2020, at 19:57, Nicolas George wrote:
> + 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.

I would add "as honestly as possible" after documented... or something like that, explaining that there are cases that canno be documented.

>+ If they were taken from a reference, include the URL of that

"from a doc/reference, name it, with section information, if applicable".

> +reference. If they were computed by a tool, include the code of the tool.

include it wehere?

> +If they were reverse-engineered, include an honest attempt at explaining the
> +methods used.

That is not even always possible. And sometimes you don't want to say how you got that table.
If a table is a math function, sure, it's doable,but if it is a decryption key, it is random...


Jean-Baptiste Kempf -  President
+33 672 704 734

More information about the ffmpeg-devel mailing list