[FFmpeg-devel] [PATCH] doc: add ffmpeg-protocols.texi manual

[Stefano Sabatini]

On date Tuesday 2012-11-27 15:30:28 +0100, Clément Bœsch encoded:
> On Mon, Nov 26, 2012 at 11:53:39PM +0100, Stefano Sabatini wrote:
> > ---
> >  doc/Makefile              |    2 +-
> >  doc/ffmpeg-protocols.texi |   37 +++++++++++++++++++++++++++++++++++++
> >  doc/libavformat.texi      |    2 +-
> >  3 files changed, 39 insertions(+), 2 deletions(-)
> >  create mode 100644 doc/ffmpeg-protocols.texi
> > 
> > diff --git a/doc/Makefile b/doc/Makefile
> > index 3168adb..1f97f31 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-resampler ffmpeg-scaler ffmpeg-formats ffmpeg-utils
> > +COMPONENTS=$(PROGS-yes) ffmpeg-codecs ffmpeg-devices ffmpeg-filters ffmpeg-protocols ffmpeg-resampler ffmpeg-scaler ffmpeg-formats ffmpeg-utils
> 
> note: maybe you should consider breaking that line at some point

Sure, will do later (also I realized that the component should really
stay on the DOCLIBS-$(...) line.

> 
> >  
> >  MANPAGES    = $(COMPONENTS:%=doc/%.1)    $(DOCLIBS-yes:%=doc/%.3)
> >  PODPAGES    = $(COMPONENTS:%=doc/%.pod)  $(DOCLIBS-yes:%=doc/%.pod)
> > diff --git a/doc/ffmpeg-protocols.texi b/doc/ffmpeg-protocols.texi
> > new file mode 100644
> > index 0000000..0bb89a0
> > --- /dev/null
> > +++ b/doc/ffmpeg-protocols.texi
> > @@ -0,0 +1,37 @@
> > +\input texinfo @c -*- texinfo -*-
> > +
> > + at settitle FFmpeg Protocols Documentation
> > + at titlepage
> > + at center @titlefont{FFmpeg Protocols Documentation}
> > + at end titlepage
> > +
> > + at top
> > +
> > + at contents
> > +
> > + at chapter Description
> > + at c man begin DESCRIPTION
> > +
> > +This document describes the input and output protocols provided by the
> > +libavformat library.
> > +
> > + at c man end DESCRIPTION
> > +
> > + at include protocols.texi
> > +
> > + at ignore
> > +
> > + at setfilename ffmpeg-protocols
> > + at settitle FFmpeg protocols
> > +
> > + at c man begin SEEALSO
> > +ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libavformat(3)
> > + at c man end
> > +
> > + at c man begin AUTHORS
> > +See Git history (git://source.ffmpeg.org/ffmpeg)
> 

> note: to "see" the git history, maybe a http url might be more
> appropriate.

I agree, but this deserves a separate global change (possibly touching
also tools manuals).

[...]
> LGTM

Will push it soon, thanks.
-- 
FFmpeg = Furious Forgiving Muttering Pacific Erudite Geek