[MPlayer-dev-eng] [PATCH] tivo vstream with DOCS

[Joey Parrish]

On Fri, Aug 20, 2004 at 07:56:17PM +0200, Diego Biurrun wrote:
> Joey Parrish writes:
> > 
> > I also added to the english xml DOCS
> 
> Nit1: You use American style two spaces between sentences, while the
> docs uses European style one space.

Ah, yes.  I grew up in the wrong country.  :)  Fixed.

> Nit2: You add a bit of trailing whitespace here and there.

Such as?

>   +.B mplayer
>   +'in +\n[.k]u
>   +.I tivo://host/list
>   +[options]
>   +.br
>   +.in
>   +.B mplayer
>   +'in +\n[.k]u
>   +.I tivo://host/llist
>   +[options]
>   +.br
>   +.in
>   +.B mplayer
>   +'in +\n[.k]u
>   +.I tivo://host/fsid
>   +[options]
>   +.br
>   +.in
> 
> What's the difference between these URL types?

There are three tivo URLs accepted.  If you use /list, you get a list of
streams available.  /llist is a more verbose list.  /fsid is a number
that represents a filesystem ID from the listings.

Should I only document part of this?  Or is there a better way to
compact these three options?

>   +  TiVo.  For more information on TiVo stream format, please refer to
>   +  <ulink url="http://dvd-create.sourceforge.net/tystudio/tystream.shtml">
>   +  this page</ulink>.
> 
> I'd say "the TiVo stream" and labelling links with "this" or "this
> page" is bad style.  Please use something more descriptive like
> "TyStudio page" or similar.

Fixed.

>   +    /* reenable swapping */
>   +    vstream_io_need_bswap(save_need_bswap);
>   +
>   +    return count;
>   +}
>   +
> 
> Are these ^L purposefully added there?  What for?

Not my code, didn't notice them.  Some people do it so that a pagefeed
is sent when printing the source.  Removed.

--Joey

-- 
"Living in the complex world of the future is somewhat
like having bees live in your head.  But, there they are."