[FFmpeg-devel] [PATCH] doc/filters: remove references to external documents

Stefano Sabatini stefasab at gmail.com
Mon Dec 17 13:59:24 CET 2012

On date Sunday 2012-12-16 16:36:31 -0500, Derek Buitenhuis encoded:
> On 16/12/2012 4:20 PM, Stefano Sabatini wrote:
> > No you need an indexing system for that, our tools just convert one
> > file from a format to another (texi -> POD -> MAN, texi -> HTML), and
> > they have no global knowledge, so can't interpret internal references
> > (an url is an url, while we want to reference another internal
> > document).
> That is not what I meant.
> An example would be:
> HTML output: <a href="stuff.html">Text<a/> is important.
> MAN output: Text is important.

> Doesn't texi have like @url{Text, http://url} ?
> No indexing is required.

There is @url{URL,TEXT}, but that doesn't do what you're asking for
(and I just discovered texi2pod.pl doesn't correctly handle that

Indeed URL in the URL command are replaced literally in the POD/man
output, and you don't want to see:

see <ffmpeg.html> manual for more details

in a manual page, but, something like:
see ffmpeg(1) manual for more details

and there is no way to reference an external resource from our
toolchain in an output-independent way (that's not impossible but
would require global indexing, that's not something I'm willing to
implement for the very limited toolchain we have, rather I'd replace
it with something more powerful - e.g. pandoc).
FFmpeg = Forgiving Faithful Most Patchable Eager Gigant

More information about the ffmpeg-devel mailing list