[FFmpeg-devel] [PATCH] doc: add libavutil.texi

[Stefano Sabatini]

On date Wednesday 2012-11-07 23:33:00 +0100, Stefano Sabatini encoded:
> On date Wednesday 2012-11-07 13:09:36 +0100, Clément Bœsch encoded:
> > On Sun, Nov 04, 2012 at 12:47:16PM +0100, Stefano Sabatini wrote:
> > > ---
> > >  doc/Makefile        |    2 +-
> > >  doc/libavcodec.texi |    2 +-
> > >  doc/libavutil.texi  |   39 +++++++++++++++++++++++++++++++++++++++
> > >  3 files changed, 41 insertions(+), 2 deletions(-)
> > >  create mode 100644 doc/libavutil.texi
> > > 
> > > diff --git a/doc/Makefile b/doc/Makefile
> > > index a5577ac..09d4543 100644
> > > --- a/doc/Makefile
> > > +++ b/doc/Makefile
> > > @@ -1,5 +1,5 @@
> > >  ifeq ($(CONFIG_AVCODEC),yes)
> > > -DOCLIBS += libavcodec
> > > +DOCLIBS += libavutil libavcodec
> > >  endif
> > >  
> > 
> > You're adding libavutil to DOCLIBS depending on lavc presence.
> > 
> > BTW, I think using the common DOCLIBS-$(CONFIG_AVCODEC) += libavcodec
> > trick would be better.
> > 
> > >  MANPAGES    = $(PROGS-yes:%=doc/%.1)    $(DOCLIBS:%=doc/%.3)
> > > diff --git a/doc/libavcodec.texi b/doc/libavcodec.texi
> > > index 5fb6b74..535bcfa 100644
> > > --- a/doc/libavcodec.texi
> > > +++ b/doc/libavcodec.texi
> > > @@ -1112,7 +1112,7 @@ Set sample format audio decoders should prefer. Default value is
> > >  @settitle multimedia streams decoding and encoding library
> > >  
> > >  @c man begin SEEALSO
> > > -ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1)
> > > +ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libavutil(3)
> > >  @c man end
> > >  
> > >  @c man begin AUTHORS
> > > diff --git a/doc/libavutil.texi b/doc/libavutil.texi
> > > new file mode 100644
> > > index 0000000..cb06526
> > > --- /dev/null
> > > +++ b/doc/libavutil.texi
> > > @@ -0,0 +1,39 @@
> > > +\input texinfo @c -*- texinfo -*-
> > > +
> > > + at settitle Libavutil Documentation
> > > + at titlepage
> > > + at center @titlefont{Libavutil Documentation}
> > > + at end titlepage
> > > +
> > > + at top
> > > +
> > > + at contents
> > > +
> > > + at chapter Description
> > > + at c man begin DESCRIPTION
> > > +
> > > +libavutil is a library containing functions for simplifying
> > > +programming, including random number generators, data structures,
> > > +mathematics routines, core multimedia utilities, and much more.
> > > +
> > 
> > You could mention crypto/crc too.
> > 
> > > + at c man end DESCRIPTION
> > > +
> > > + at include syntax.texi
> > > + at include eval.texi
> > > +
> > > + at ignore
> > > +
> > > + at setfilename libavutil
> > > + at settitle multimedia core utiltities library
> > > +
> > 
> > Strange word.
> > 
> > > + at c man begin SEEALSO
> > > +ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1)
> > > + at c man end
> > > +
> > > + at c man begin AUTHORS
> > > +See git history
> > > + at c man end
> > > +
> > > + at end ignore
> > > +
> > > + at bye
> > 
> > Rest LGTM
> 
> Updated. Will push tomorrow or later, thanks.

Pushed.
-- 
FFmpeg = Fabulous and Foolish Magical Purposeless Embarassing Geisha