[MPlayer-DOCS] [PATCH] document a couple more x264 options in mencoder.xml

[Guillaume POIRIER]

Hi,

On 5/31/05, Jeff Clagg <snacky at ikaruga.co.uk> wrote:
> On Mon, May 30, 2005 at 11:16:33PM +0200, Guillaume POIRIER wrote:
> > Looks good to me, except that I think it would be a good idea to
> > explain what each me option means: (1=diamond search, radius 1,
> > 2=hexagon search, radius 2, 3=uneven multi-hexagon search)
> 
> I don't think I mind seeing this explained in the xml docs, but one of
> the reasons I didn't bother is because I can't improve on the
> explanation in the manpage, and readers are explicitly encouraged to go
> look at it.
> 
> There's a related issue here, which is separating the function of the
> man page and the function of the xml docs. With lavc, it's now pretty
> much an accomplished fact that the manpage is an exhaustive list of all
> options, with terse (but well-worded) technical explanations of what
> each option actually does.

BTW, if you can come up with better descriptions for lavc options,
you're welcome to do so. (yeah, I know I'm the one who was told to do
so, but I guess it doesn't hurt to unify our workforce)


> The xml docs pick out the few that are of
> highest interest to most end-users, and discuss their impacts on speed
> and quality, and how this impact differs depending on the source, and so
> on.

Yeah, I guess you're right. All the more since the me options may
still evolve, which means that both the xml doc and the man page would
have to be kept in sync, which means more work...

> Anyway, my intention was to get straight to the point: results are the
> first thing the user cares about. This is why I'm trying to establish a
> pattern of listing example speed and PSNR changes for each option, but I
> don't bother so much with technical details. Notice I also never
> explained what subq, frameref, or b_pyramid really do, either. If users
> want to know, there are excellent explanations in the man page.

I agree.

Regards,
Guillaume
-- 
Jazz music and Open Source development looks like chaos to an
untrained eye, but end-up producing masterpieces like "Kind of Blue"
and "MPlayer".
That's why I love them both...
  -- John Coltrane