[FFmpeg-devel] [PATCH] doc: add libavformat.texi and ffmpeg-formats.texi files

[Stefano Sabatini]

On date Tuesday 2012-11-27 15:46:26 +0100, Clément Bœsch encoded:
> On Mon, Nov 26, 2012 at 11:34:39AM +0100, Stefano Sabatini wrote:
> [...]
> > From 443b822f3e56be0135b531c5814b35d35e16cf30 Mon Sep 17 00:00:00 2001
> > From: Stefano Sabatini <stefasab at gmail.com>
> > Date: Sun, 18 Nov 2012 13:39:18 +0100
> > Subject: [PATCH] doc: add libavformat.texi and ffmpeg-formats.texi files
> > 
> > ---
> >  doc/Makefile            |    3 +-
> >  doc/ffmpeg-formats.texi |  161 +++++++++++++++++++++++++++++++++++++++++++++++
> >  doc/libavformat.texi    |   40 ++++++++++++
> >  3 files changed, 203 insertions(+), 1 deletion(-)
> >  create mode 100644 doc/ffmpeg-formats.texi
> >  create mode 100644 doc/libavformat.texi
> > 
> > diff --git a/doc/Makefile b/doc/Makefile
> > index 85ca978..1dea375 100644
> > --- a/doc/Makefile
> > +++ b/doc/Makefile
> > @@ -2,9 +2,10 @@ DOCLIBS-$(CONFIG_AVUTIL)  += libavutil
> >  DOCLIBS-$(CONFIG_SWSCALE) += libswscale
> >  DOCLIBS-$(CONFIG_SWRESAMPLE) += libswresample
> >  DOCLIBS-$(CONFIG_AVCODEC) += libavcodec
> > +DOCLIBS-$(CONFIG_AVFORMAT) += libavformat
> >  DOCLIBS-$(CONFIG_AVFILTER) += libavfilter
> >  
> > -COMPONENTS=$(PROGS-yes) ffmpeg-codecs ffmpeg-filters ffmpeg-resampler ffmpeg-scaler
> > +COMPONENTS=$(PROGS-yes) ffmpeg-codecs ffmpeg-filters ffmpeg-resampler ffmpeg-scaler ffmpeg-formats
> >  
> >  MANPAGES    = $(COMPONENTS:%=doc/%.1)    $(DOCLIBS-yes:%=doc/%.3)
> >  PODPAGES    = $(COMPONENTS:%=doc/%.pod)  $(DOCLIBS-yes:%=doc/%.pod)
> > diff --git a/doc/ffmpeg-formats.texi b/doc/ffmpeg-formats.texi
> > new file mode 100644
> > index 0000000..d7f0192
> > --- /dev/null
> > +++ b/doc/ffmpeg-formats.texi
> > @@ -0,0 +1,161 @@
> > +\input texinfo @c -*- texinfo -*-
> > +
> > + at settitle FFmpeg Formats Documentation
> > + at titlepage
> > + at center @titlefont{FFmpeg Formats Documentation}
> > + at end titlepage
> > +
> > + at top
> > +
> > + at contents
> > +
> > + at chapter Description
> > + at c man begin DESCRIPTION
> > +
> > +This document describes the supported formats (muxers and demuxers)
> > +provided by the libavformat library.
> > +
> 
> libavformat(3)?

I still don't know how to find a good way to reference a manual in a
non-man-specific way, so I'll leave it the way it is for now.

[...] 
> LGTM

Thanks, will push it soon.
-- 
FFmpeg = Fiendish & Fabulous Meaningless Perfectionist Eccentric Gadget