Bug#438369: ffmpeg status?

[Reinhard Tartler]

(CC'ing the bug, it should/will redirect to the mailing list anyways..)

Fabian Greffrath <greffrath at leat.rub.de> writes:

> Reinhard Tartler schrieb:
>>  - an ffmpeg-doc package containing the doxygen documentation
>
> I tried this by simply running 'doxygen' in the source directory.
>
> A new directory 'doxy' will be created, containing two other directories
> html' and 'latex'. The 'html' directory contains a huge load of .html
> files and an index.html for webbrowser usage - fine.

The bug requested exactly this kind of documentation.

> The 'latex' directory contains a bunch of .latex files (which are rather
> useless if not compiled by a LaTeX interpreter) and a Makefile which can
> be used to generate dvi, ps or pdf versions of the documentation.

Yes, that's standard doxygen behavior.

> Two questions:
> 1) Should we really Build-Depend on a whole LaTeX environment only to
> create another copy of the same documentation again?

Unless some user requests this, I wouldn't do that. PDF might be easier
to print though. Still, such users are more likely to fetch the sources
and just regenerate the pdf on their own.

Having the html doxygen ffmpeg api on the local disk might however be
pretty handy, that's what the bug is about.

> -- If yes, should we build all flavours of the output format, i.e. dvi,
> ps and pdf? For the case we only want to build the pdf file, we should
> patch Doxyfile to enable USE_PDFLATEX.
> -- If no, we should patch Doxyfile to disable GENERATE_LATEX to
> disburden the autobuilders.

I'd vote for no, and just ignore the generated latex sources. Generating
them does not need latex on the buildds, only actually processing them.

OTOH we can save some cpucycles spent by doxygen by disabling
GENERATE_LATEX, right.

> 2) Doxygen throws an error stating that Doxyfile is outdated and that
> doxygen -u' should be run. Should we patch Doxyfile to the content after
> the update?

Is that really an error or just a warning? In any case, I think this is
something that should be fixed upstream. Let's update the file and sent
it upstream as a patch.

-- 
Gruesse/greetings,
Reinhard Tartler, KeyID 945348A4