[FFmpeg-devel] [PATCH] doc: add ffmpeg-bitstream-filters.texi file

[Stefano Sabatini]

On date Tuesday 2012-11-27 11:33:48 +0100, Nicolas George encoded:
> Le septidi 7 frimaire, an CCXXI, Stefano Sabatini a écrit :
> > ---
> >  doc/Makefile                      |    2 +-
> >  doc/ffmpeg-bitstream-filters.texi |   40 +++++++++++++++++++++++++++++++++++++
> >  doc/libavcodec.texi               |    5 +++--
> >  3 files changed, 44 insertions(+), 3 deletions(-)
> >  create mode 100644 doc/ffmpeg-bitstream-filters.texi
> > 
> > diff --git a/doc/Makefile b/doc/Makefile
> > index 1f97f31..f74c6af 100644
> > --- a/doc/Makefile
> > +++ b/doc/Makefile
> > @@ -6,7 +6,7 @@ DOCLIBS-$(CONFIG_AVFORMAT) += libavformat
> >  DOCLIBS-$(CONFIG_AVFORMAT) += libavdevice
> >  DOCLIBS-$(CONFIG_AVFILTER) += libavfilter
> >  
> > -COMPONENTS=$(PROGS-yes) ffmpeg-codecs ffmpeg-devices ffmpeg-filters ffmpeg-protocols ffmpeg-resampler ffmpeg-scaler ffmpeg-formats ffmpeg-utils
> > +COMPONENTS=$(PROGS-yes) ffmpeg-bitstream-filters ffmpeg-codecs ffmpeg-devices ffmpeg-filters ffmpeg-protocols ffmpeg-resampler ffmpeg-scaler ffmpeg-formats ffmpeg-utils
> 

> If I understand this correctly, this makes a separate man page for just
> that. I am not sure this is a good idea.
> 
> For one, it is very short, that may be splitting too much.

Yes, but this is consistent with the general layout.
 
> For two, I suspect a lot of people do not know exactly what bitstream
> filters are, or even that they exist: they want filters that do something,
> the technical details do not matter.
> 
> Therefore, I suspect that bitstreams filters would be better documented as a
> chapter in ffmpeg-filters(1).

Currently bitstream filters depend on libavcodec, so putting them
together with media-level filters may be confusing (and I want to
disable manual pages for which the corresponding library is disabled).

The other options was to put components docs in the corresponding
lib*.texi file, but that was rejected for other reasons.

So while this is slightly suboptimal, it is still the best solution I
could come up with.

> And someday, they should be made part of lavfi anyway, IMHO.
-- 
FFmpeg = Foolish & Fantastic Minimal Porno Erudite Governor