When setting up a repository, a config file must be filled out. The required fields are:

• description
• logging and/or license
• email

The rest of the fields are optional.

Required Fields

The description field should contain a short description of the project this repository represents.

description:  project description goes here 

There also needs to be a contact person for the repository following the email field, add your email address for that field.

email: user@domain

To tell BitKeeper which mode to run in, the logging specifications must be outlined in the config file. If you are a commercial client set the following:

logging: none
license: your_license_key

logging: logging@openlogging.org

logging: none
single_user: your_login
single_host: your_machine_name

User Preferences

With BitKeeper, once files are checked in, by default the clear text version does not exist. It is possible to change that default to check out files in read-only mode (set ``checkout:'' to ``get'') or edit mode (set ``checkout:'' to ``edit''). If checkout: is left blank, the default behavior will occur.

checkout:

The checkout preference can be set per user, per host, or per repository via these filters:

• per user
  [jdoe:]checkout: get
• per host
  [@xyz.com:]checkout: none
• per user@host
  [jdoe@xyz.com:]checkout: get
• per repository
  [/path/to/repository:]checkout: edit
  [@xyz.com:/path/to/repository:]checkout: get
  [jdoe@xyz.com:/path/to/repository:]checkout: edit

Owner Information

To specify contact information, so that someone from BitMover can contact you if a problem with BitKeeper is discovered, add the appropriate information:

contact:
phone:

You may create a global config file and use that upon every setup:

bk setup -cconfig_file