[MPlayer-cvslog] CVS: main get_path.c,1.11,1.12

[The Wanderer]

Diego Biurrun wrote:

> On Sat, Oct 29, 2005 at 03:30:34PM +0200, Guillaume POIRIER wrote:
> 
>> On 10/29/05, Alban Bedel CVS <syncmail at mplayerhq.hu> wrote:
>> 
>>> Modified Files:
>>>         get_path.c
>>> Log Message:
>>> Allow the user to set the $MPLAYER_HOME environment variable to
>>> point to the location were they want mplayer to store its 
>>> configuration stuff.
>> 
>> This feature should be somehow documented, I think.
> 
> Yes, but where?  There is no good place to document this ATM...

IIRC I've seen some man pages with a section headed "ENVIRONMENT
VARIABLES"; it'd be a bit clunky to have such a section for just one
variable, but although I'm not entirely happy with adding yet *more* to
the already-fhuge man page, doing so would at least provide one possible
solution.

Alternately and/or in addition (just brainstorming randomly here), it
might not hurt to have a section in the XML docs covering the config
files themselves - that is, explaining about things like what can and
cannot be handled via a config file (I think the answer is "everything
which can be handled on the command line"?), and the fallback-chain idea
(with concepts like the terminal comma, which is currently documented in
somewhere I don't recall offhand), and what can go in different types of
config files (I think there are three - MPlayer-specific,
MEncoder-specific, and file-specific), and what happens if (say) an
MEncoder option winds up in an MPlayer config file. Then again doing all
of that might be overkill, especially since it would potentially mean
*two* places to update the docs if behaviour changed, but...

-- 
       The Wanderer

Warning: Simply because I argue an issue does not mean I agree with any
side of it.

Secrecy is the beginning of tyranny.