[FFmpeg-devel] [PATCH] Add an "How does it work" section in ffserver-doc.texi

[Diego Biurrun]

On Wed, Jun 18, 2008 at 11:03:48AM +0200, Stefano Sabatini wrote:
> On date Monday 2008-06-16 11:10:53 +0200, Luca Abeni encoded:
> > 
> > note that ffserver can also stream "static" files via RTP (for
> > example, see the test1-rtsp.mpg or the test1-sdp.mpg entries
> > in ffserver.conf). So, not all the ffserver streams need a live
> > feed.
> > (and, BTW, isn't ffserver able to automatically start ffmpeg
> > for its live feeds? From this patch, it seems that the ffmpeg
> > instances have to be started by the user...)
> 
> Hi all, thanks to Luca and Diego for their feedback, new patch
> attached.

In general, your sentences are much too loooooong.  As a rule of thumb,
try to keep sentences as short as possible.

> --- doc/ffserver-doc.texi	(revision 13799)
> +++ doc/ffserver-doc.texi	(working copy)
> @@ -26,6 +26,28 @@
>  
> + at section How does it work?
> +
> +FFserver works by receiving as input prerecorded files or receiving
> +one or more FFM streams by some running instances of ffmpeg, then
> +streaming them through RTP/RTSP/HTTP protocols.

FFserver receives prerecorded files or FFM streams from an ffmpeg
instance as input, then streams them over RTP/RTSP/HTTP.

> +An ffserver instance will listen to some port as specified in the

listen on

> +configuration file. Then you can launch one or more instances of

s/then//

> +ffmpeg and send one or more FFM streams to the port where ffserver is
> +expecting to receive them; or you can make ffserver launch
> +automatically such instances of ffmpeg at startup (check the <Launch>
> +section in the configuration file).

Just split the sentence at the semicolon.

> +Input streams are called feeds, and for each one of these you can have

Input streams are called feeds. For each feed you can have

> +different corresponding output streams in various formats as specified
> +in the configuration file.

s/corresponding//

> +In the configuration file you need also to specify how to map the
> +input streams, each one specified by a <Feed> section, to the various
> +output streams which ffserver will be able to stream on request, each
> +one specified by a corresponding <Stream> section.

This is a good example of a bad long sentence.  I have to reread it to
understand what "each one" is referring to and I am still confused.
Please split it into 2-3 parts.

Diego