[FFmpeg-devel] [PATCH] doc: extend "See Also" chapters in library manuals

[Stefano Sabatini]

On date Tuesday 2012-12-18 02:43:24 +0100, Clément Bœsch encoded:
> On Tue, Dec 18, 2012 at 01:39:32AM +0100, Stefano Sabatini wrote:
> > In particular, make "See Also" chapter rendered in HTML output.
> > ---
> >  doc/libavcodec.texi    |   19 ++++++++++++++-----
> >  doc/libavdevice.texi   |   19 ++++++++++++++-----
> >  doc/libavfilter.texi   |   19 +++++++++++++++----
> >  doc/libavformat.texi   |   18 ++++++++++++++----
> >  doc/libavutil.texi     |   16 ++++++++++++----
> >  doc/libswresample.texi |   18 ++++++++++++++----
> >  doc/libswscale.texi    |   18 ++++++++++++++----
> >  7 files changed, 97 insertions(+), 30 deletions(-)
> > 
> > diff --git a/doc/libavcodec.texi b/doc/libavcodec.texi
> > index 27cea2c..2b11201 100644
> > --- a/doc/libavcodec.texi
> > +++ b/doc/libavcodec.texi
> > @@ -22,6 +22,20 @@ implementing robust and fast codecs as well as for experimentation.
> >  
> >  @c man end DESCRIPTION
> >  
> > + at chapter See Also
> > +
> > + at ifhtml
> > + at url{ffmpeg.html,ffmpeg}, @url{ffplay.html,ffplay}, @url{ffprobe.html,ffprobe}, @url{ffserver.html,ffserver},
> > + at url{ffmpeg-codecs.html,ffmpeg-codecs}, @url{ffmpeg-bitstream-filters.html,bitstream-filters},
> > + at url{libavutil.html,libavutil}
> > + at end ifhtml
> > +
> > + at ifnothtml
> > +ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1),
> > +ffmpeg-codecs(1), ffmpeg-bistream-filters(1),
> 
> The typo was already present, but you may want to fix it: *bitstream*
> 
> [...]
> > + at chapter See Also
> > +
> > + at ifhtml
> > + at url{ffmpeg.html,ffmpeg}, @url{ffplay.html,ffplay}, @url{ffprobe.html,ffprobe}, @url{ffserver.html,ffserver},
> > + at url{ffmpeg-scaler.html,ffmpeg-scaler},
> > + at url{libavutil.html,libavutil}
> > + at end ifhtml
> > +
> > + at ifnothtml
> > +ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1),
> > +ffmpeg-scaler(1),
> > +libavutil(3)
> > + at end ifnothtml
> > +
> >  @include authors.texi
> >  
> >  @ignore
> > @@ -44,10 +58,6 @@ colorspaces differ.
> >  @setfilename libswscale
> >  @settitle video scaling and pixel format conversion library
> >  
> > - at c man begin SEEALSO
> > -ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), ffmpeg-scaler(1), libavutil(3)
> > - at c man end
> > -
> 
> Is "@chapter See Also" still following the man page semantic generated
> with "@c man begin SEEALSO"?

SEEALSO was translated to "SEE ALSO" by the script, so the resulting
name is unchanged.

> 
> [...]
> 
> Patch should be OK otherwise.

Pushed, thanks for the reviews.
-- 
FFmpeg = Fantastic Fostering Magical Problematic Ecumenical Gigant