[FFmpeg-devel] [RFC] Better modularization and extension of docs - 2

[Nicolas George]

Le duodi 22 fructidor, an CCXX, Stefano Sabatini a écrit :
> I find the monolithic FFmpeg pages more and more clumsy, e.g. when I
> want to look for information related to a filter. In that case a:
> man ffmpeg-filters
> 
> would be much better, and would avoid redundancy in the ff* tool
> pages.

I am all in favor of that.

> Possible sections would be:
> 
> tools: ffmpeg/ffplay/ffprobe/ffserver

Of course.

> protocols
> muxers
> demuxers
> indevs
> outdevs
> decoders
> encoders
> bitstream-filters/bsfs
> filters
> 
> It may made sense to merge muxers/demuxers => formats,
> indevs/outdevs => devices, decoders/encoders => codecs.
> 
> What do you think?

IMHO, bitstream-filters belongs with filters, just in a separate section:
the difference is an implementation detail, and it avoids the clumsy name.
Apart from that, merging or separating would mostly depend on the total
amount of information.

Note that is is possible to make a meta-man-page that loads all parts in a
single call.


Also, wild idea: include the documentation in the library, so that GUI apps
can display it.

Regards,

-- 
  Nicolas George
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 198 bytes
Desc: Digital signature
URL: <http://ffmpeg.org/pipermail/ffmpeg-devel/attachments/20120909/b844ca5b/attachment.asc>