[FFmpeg-devel] [PATCH] doc/ffserver: rework introducing paragraphs of the "description" chapter

[Stefano Sabatini]

On date Friday 2013-01-11 18:15:16 +0100, Alexander Strasser encoded:
> Stefano Sabatini wrote:
> > In particular, add some markup, fix empty line, and merge it with "How
> > does it work?" section.
> > ---
> >  doc/ffserver.texi |   40 +++++++++++++++++-----------------------
> >  1 file changed, 17 insertions(+), 23 deletions(-)
> > 
> > diff --git a/doc/ffserver.texi b/doc/ffserver.texi
> > index 6fa8dc1..83756b8 100644
> > --- a/doc/ffserver.texi
> > +++ b/doc/ffserver.texi
> > @@ -16,34 +16,28 @@ ffserver [@var{options}]
> >  @chapter Description
> >  @c man begin DESCRIPTION
> >  
> > -ffserver is a streaming server for both audio and video. It supports
> > + at command{ffserver} is a streaming server for both audio and video. It
> > +supports several live feeds, streaming from files and time shifting on
> > +live feeds (you can seek to positions in the past on each live feed,
> > +provided you specify a big enough feed storage in
> > + at file{ffserver.conf}).
> >  
> > -several live feeds, streaming from files and time shifting on live feeds
> > -(you can seek to positions in the past on each live feed, provided you
> > -specify a big enough feed storage in ffserver.conf).
> > + at command{ffserver} receives prerecorded files or FFM streams from some
> > + at command{ffmpeg} instance as input, then streams them over
> > +RTP/RTSP/HTTP.
> >  
> > -This documentation covers only the streaming aspects of ffserver /
> > -ffmpeg. All questions about parameters for ffmpeg, codec questions,
> > -etc. are not covered here. Read @file{ffmpeg.html} for more
> > -information.
> > +An @command{ffserver} instance will listen on some port as specified
> > +in the configuration file. You can launch one or more instances of
> > + at command{ffmpeg} and send one or more FFM streams to the port where
> > +ffserver is expecting to receive them. Alternately, you can make
> > + at command{ffserver} launch such @command{ffmpeg} instances at startup.
> >  
> > - at section How does it work?
> > -
> > -ffserver receives prerecorded files or FFM streams from some ffmpeg
> > -instance as input, then streams them over RTP/RTSP/HTTP.
> > -
> > -An ffserver instance will listen on some port as specified in the
> > -configuration file. You can launch one or more instances of ffmpeg and
> > -send one or more FFM streams to the port where ffserver is expecting
> > -to receive them. Alternately, you can make ffserver launch such ffmpeg
> > -instances at startup.
> > -
> > -Input streams are called feeds, and each one is specified by a <Feed>
> > -section in the configuration file.
> > +Input streams are called feeds, and each one is specified by a
> > + at code{<Feed>} section in the configuration file.
> >  
> >  For each feed you can have different output streams in various
> > -formats, each one specified by a <Stream> section in the configuration
> > -file.
> > +formats, each one specified by a @code{<Stream>} section in the
> > +configuration file.
> >  
> >  @section Status stream
> 

>   Read it two times and certainly cannot really compare it to the
> previous version all in my head. I am too lazy too generate and
> compare both version at the moment. But I can say the new version
> reads fine to me and should certainly look nicer when rendered. And
> though I noticed you dropped some things, they seem unimportant or
> maybe even irritating AFAICT.

I dropped this part altogether:

-This documentation covers only the streaming aspects of ffserver /
-ffmpeg. All questions about parameters for ffmpeg, codec questions,
-etc. are not covered here. Read @file{ffmpeg.html} for more
-information.

which seems pretty pointless to me.
-- 
FFmpeg = Frenzy Freak Mysterious Picky Esoteric Gigant