autotest/autotest — Issue #114: Add comments to global_config.ini
Author: kparal
Created: 2011-12-13 08:45:07+00:00
State: open

### Problem
Currently it's hard to set up `global_config.ini` properly, because lots of options are missing documentation. The missing documentation is available at http://autotest.kernel.org/wiki/GlobalConfig. But:
1) you have to know that you should look for this wiki page
2) the wiki page is very hard to find (github wiki is not searchable, the only way how to access it I know of is through https://github.com/autotest/autotest/wiki/_pages)

### Proposal
Have a policy that every option in config file(s) must be documented.

### Implementation
1. Transfer all documentation from `GlobalConfig` wiki page into `global_config.ini`.
2. There will be still some options undocumented, add comments for those.
3. There might be some documentation that is too extensive for including in the .ini file. That is OK, leave it in GlobalConfig.
4. In the beginning of `global_config.ini` put a link to `GlobalConfig`.