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

[Stefano Sabatini]

On date Wednesday 2013-04-03 02:44:32 +0200, Michael Niedermayer encoded:
> On Sat, Mar 30, 2013 at 05:06:09PM +0100, Stefano Sabatini wrote:
> > 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.
> 
> if it depends on compile time options then i dont want to be
> the one dealing with users
> "why does my man ffmpeg not describe option X"
> "I did X and suddenly half the options are missing in the
>  documentation" 
> 
>  or "please look in man ffmpeg" ... "i do but its not documented
>  there" ...

Good point.

What about this:
ff* and ff*-all pages are *always* both compiled.

This should also simplify integration on the webserver, and "man
ffmpeg-all" is so much better than "man ffmpeg-monolithic".

[...]
-- 
FFmpeg = Frightening & Fast Multimedia Perennial Evanescent Glue