[FFmpeg-devel] [PATCH] doc: move syntax and eval chapters from libavutil to ffmpeg-utils

[Clément Bœsch]

On Mon, Nov 26, 2012 at 11:49:11PM +0100, Stefano Sabatini wrote:
> Move utilities description to a dedicated manual, consistent with what I
> did with the rest of the documentation.
> ---
>  doc/Makefile          |    2 +-
>  doc/ffmpeg-utils.texi |   38 ++++++++++++++++++++++++++++++++++++++
>  doc/libavutil.texi    |    5 +----
>  3 files changed, 40 insertions(+), 5 deletions(-)
>  create mode 100644 doc/ffmpeg-utils.texi
> 
> diff --git a/doc/Makefile b/doc/Makefile
> index 9582231..3168adb 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
> +COMPONENTS=$(PROGS-yes) ffmpeg-codecs ffmpeg-devices ffmpeg-filters ffmpeg-resampler ffmpeg-scaler ffmpeg-formats ffmpeg-utils
>  
>  MANPAGES    = $(COMPONENTS:%=doc/%.1)    $(DOCLIBS-yes:%=doc/%.3)
>  PODPAGES    = $(COMPONENTS:%=doc/%.pod)  $(DOCLIBS-yes:%=doc/%.pod)
> diff --git a/doc/ffmpeg-utils.texi b/doc/ffmpeg-utils.texi
> new file mode 100644
> index 0000000..5d51fc8
> --- /dev/null
> +++ b/doc/ffmpeg-utils.texi
> @@ -0,0 +1,38 @@
> +\input texinfo @c -*- texinfo -*-
> +
> + at settitle FFmpeg Utilities Documentation
> + at titlepage
> + at center @titlefont{FFmpeg Utilities Documentation}
> + at end titlepage
> +
> + at top
> +
> + at contents
> +
> + at chapter Description
> + at c man begin DESCRIPTION
> +
> +This document describes some generic features and utilities provided
> +by the libavutil library.

libavutil(3) ?

> +
> + at c man end DESCRIPTION
> +
> + at include syntax.texi
> + at include eval.texi
> +
> + at ignore
> +
> + at setfilename ffmpeg-utils
> + at settitle FFmpeg utilities
> +
> + at c man begin SEEALSO
> +ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libavutil(3)
> + at c man end
> +
> + at c man begin AUTHORS
> +See Git history (git://source.ffmpeg.org/ffmpeg)
> + at c man end
> +
> + at end ignore
> +
> + at bye
> diff --git a/doc/libavutil.texi b/doc/libavutil.texi
> index e5304bb..c12d7ff 100644
> --- a/doc/libavutil.texi
> +++ b/doc/libavutil.texi
> @@ -20,16 +20,13 @@ enumerations for pixel and sample formats).
>  
>  @c man end DESCRIPTION
>  
> - at include syntax.texi
> - at include eval.texi
> -
>  @ignore
>  
>  @setfilename libavutil
>  @settitle multimedia-biased utility library
>  
>  @c man begin SEEALSO
> -ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1)
> +ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), ffmpeg-utils(1)
>  @c man end
>  
>  @c man begin AUTHORS

LGTM

-- 
Clément B.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 490 bytes
Desc: not available
URL: <http://ffmpeg.org/pipermail/ffmpeg-devel/attachments/20121127/f56a5190/attachment.asc>