[FFmpeg-devel] [PATCH] doc: enable compilation of monolithic tools doc with --enable-monolithic-tools-doc

Stefano Sabatini stefasab at gmail.com
Sun Mar 31 23:06:13 CEST 2013


On date Saturday 2013-03-30 18:37:24 +0100, Stefano Sabatini encoded:
> On date Saturday 2013-03-30 17:06:09 +0100, Stefano Sabatini encoded:
> > On date Sunday 2013-03-24 13:53:47 +0100, Michael Niedermayer encoded:
> > > On Tue, Mar 19, 2013 at 10:25:24PM +0100, Stefano Sabatini wrote:
> > > > On date Tuesday 2013-03-19 20:56:11 +0100, Stefano Sabatini encoded:
> > > > > Fix trac issue #2374.
> > > > > ---
> > > > >  configure         |    8 +++++++-
> > > > >  doc/ffmpeg.texi   |   12 ++++++++++++
> > > > >  doc/ffplay.texi   |   12 ++++++++++++
> > > > >  doc/ffprobe.texi  |   12 ++++++++++++
> > > > >  doc/ffserver.texi |   12 ++++++++++++
> > > > >  5 files changed, 55 insertions(+), 1 deletion(-)
> > > > 
> > > > Updated with a few minor fixes.
> > > > 
> > > > Website inclusion may be a bit complicate, as it is not very clear if
> > > > we should link by default the monolithic (more
> > > > lazy-grepping-user-friendly) or the more readable slim version.
> > > > 
> > > 
> > > > Ideally we should include both which means we should build both
> > > > variants which may implicate a few complications to the updater
> > > > script.
> > > 
> > > why not build both by default ?
> > > maybe by adding:
> > > doc/ffmpeg-monolithic.texi
> > > doc/ffplay-monolithic.texi
> > 
> > In this case the user will have to do:
> > man ffmpeg-monolithic.1
> > 
> > to read the monolithic document, while with the current approach it
> > depends on compilation options.
> > 
> > I'm fine with both approaches.
> 
> Anyway before painting the bikeshed I'd like to get the work in, then
> somebody more motivated than me can fill in the missing features in
> case he wants all the possible permutations of more-or-less
> monolithic.
> 
> Complete patchset is:
>  doc: move ffmpeg-codecs.texi content to separated file
>  doc: move ffmpeg-formats.texi content to separated file
>  doc: move ffmpeg-devices.texi content to separated file
>  doc: move ffmpeg-resampler.texi content to separated file
>  doc: move ffmpeg-scaler.texi content to separated file
>  doc: enable compilation of monolithic tools pages with --enable-monolithic-tools-doc
> 
> The first patches are trivial move around of documentation, from
> ffmpeg-x.texi file to x.texi file.
> 
> Updated version of the last patch in attachment.
> -- 
> FFmpeg = Fabulous & Faithful Miracolous Puristic Erratic Gem

> From 310b0ac57e796b4086ecd0cc0835706b9553f74f Mon Sep 17 00:00:00 2001
> From: Stefano Sabatini <stefasab at gmail.com>
> Date: Tue, 19 Mar 2013 20:54:26 +0100
> Subject: [PATCH] doc: enable compilation of monolithic tools pages with
>  --enable-monolithic-tools-doc
> 
> In particular, add documentation configuration system, through the
> doc/config.texi file.
[...]

Ping.

I can apply the moving around patches, and split the configuration
stuff in a separate commit, which should be useful whatever path we
decide to follow.
-- 
FFmpeg = Formidable & Faithful Mega Pacific Extended God


More information about the ffmpeg-devel mailing list