~bzr-pqm/bzr/bzr.dev

Viewing changes to doc/configuration.txt

Committer: James Westby
Date: 2007-07-13 22:35:07 UTC
mto: (2619.1.1 jam-integration)
mto: This revision was merged to the branch mainline in revision 2621.
Revision ID: jw+debian@jameswestby.net-20070713223507-lpvkrwy79opb29oo

Split out bug tracker configuration in to its own file.

Make a few small changes in configuration.txt as well.

Maybe configuration.txt should have a link to the bug_trackers.txt
file.

files added:
doc/bug_trackers.txt

files modified:
doc/README.1st

doc/configuration.txt

Show diffs side-by-side

added added

removed removed

doc/configuration.txt

Information on how to configure Bazaar.

Location of configuration file

==============================

Location of configuration files

===============================

Each user gets a pair of configurations files in ``$HOME/.bazaar``. The first

one, named ``bazaar.conf``, includes default configuration options. The other

file, ``locations.conf``, contains configuration information for specific

branch locations. These files are sometimes referred to as ``ini files``.

Each branch can also contain a configuration file that sets values specific

to that branch. This file is found at ``.bzr/branch/branch.conf`` within the

branch. This file is visible to all users of a branch, if you wish to override

one of the values for a branch with a setting that is specific to you then you

can do so in ``locations.conf``.

General Format

==============

An ini file has three types of contructs: section headers, section

[/home/jdoe/branches/]

Section Variables

-----------------

128

133

editor

129

134

------

130

135

The path of the editor that you wish to use if *bzr commit* is run without

131

a commit log message. This setting is trumped by the environment variable

136

a commit message. This setting is trumped by the environment variable

132

137

``$BZR_EDITOR``, and overrides ``$VISUAL`` and ``$EDITOR``.

133

138

134

139

check_signatures

189

194

----------------------------

190

195

User and password to authenticate to the SMTP server. If smtp_username

191

196

is set, and smtp_password is not, Bazaar will prompt for a password.

197

These settings are only needed if the SMTP server requires authentication

198

to send mail.

192

199

193

200

194

201

Branch 6 Options

209

216

---------------

210

217

If present, the location of the default branch for pull or merge.

211

218

This option is normally set by ``pull --remember`` or ``merge

212

--remember``

219

--remember``.

213

220

214

221

push_location

215

222

-------------

226

233

If set to "True", the branch should act as a checkout, and push each commit to

227

234

the bound_location. This option is normally set by ``bind``/``unbind``.

228

235

229

230

Bug Tracker Options

231

===================

232

233

These options can go into bazaar.conf, branch.conf or into a branch-specific

234

configuration section in locations.conf.

235

236

bugzilla_<tracker_abbreviation>_url

237

-----------------------------------

238

If present, the location of the Bugzilla bug tracker referred to by

239

<tracker_abbreviation>. This option can then be used together with ``bzr commit

240

--fixes`` to mark bugs in that tracker as being fixed by that commit. For

241

example::

242

243

bugzilla_squid_url = http://www.squid-cache.org/bugs

244

245

would allow ``bzr commit --fixes squid:1234`` to mark Squid's bug 1234 as

246

fixed.

247

248

trac_<tracker_abbrevation>_url

249

------------------------------

250

If present, the location of the Trac instance referred to by

251

<tracker_abbreviation>. This option can then be used together with ``bzr commit

252

--fixes`` to mark bugs in that tracker as being fixed by that commit. For

253

example::

254

255

trac_twisted_url = http://www.twistedmatrix.com/trac

256

257

would allow ``bzr commit --fixes twisted:1234`` to mark Twisted's bug 1234 as

258

fixed.

Older »