doc/config.txt

   1 *************
   2 Configuration
   3 *************
   4
   5 Config file format and location
   6 ===============================
   7
   8 Most of the information that BE needs lives in the bug repository
   9 itself, but there is user-specific information that does not fit into
  10 a shared repository.  This per-user configuration information is
  11 stored in an `INI-style config file`__::
  12
  13   [default]
  14   user = 'John Doe <jdoe@example.com>'
  15
  16 __ configparser_
  17
  18 The config file is located at :file:`~/.config/bugs-everywhere` by
  19 default, but you can override the path by setting environment
  20 variables (see :py:func:`~libbe.storage.util.config.path` for
  21 details).
  22
  23 Settings
  24 ========
  25
  26 Currently the only information stored in the configuration file is a
  27 user ID (see :py:func:`~libbe.ui.util.user.get_user_id`), as shown in
  28 the example above.  However, many version control systems allow you to
  29 specify your name and email address, and BE will fall back to the
  30 VCS-configured values, so you probably don't need to set a BE-specific
  31 configuration.
  32
  33
  34 .. _configparser: http://docs.python.org/library/configparser.html