~ubuntu-branches/debian/sid/trac-bzr/sid

« back to all changes in this revision

Viewing changes to README

  • Committer: Package Import Robot
  • Author(s): Jelmer Vernooij
  • Date: 2012-03-12 15:24:14 UTC
  • mfrom: (1.1.9)
  • Revision ID: package-import@ubuntu.com-20120312152414-yi6wngu8vgm266fp
Tags: 0.4.2+bzr125-1
* New upstream snapshot.
* Bump standards version to 3.9.3 (no changes).
* Use DEP-5 for copyright file.

Show diffs side-by-side

added added

removed removed

Lines of Context:
16
16
| Copyright (C) 2006 Marien Zwart <marienz@gentoo.org>
17
17
| Copyright (C) 2006,2007 Panoramic Feedback <abentley@panoramicfeedback.com>
18
18
| Copyright (C) 2006,2008,2009,2010 Jelmer Vernooij <jelmer@samba.org>
19
 
| Copyright (C) 2009,2010 Martin von Gagern <Martin.vGagern@gmx.net>
 
19
| Copyright (C) 2009,2010,2011 Martin von Gagern <Martin.vGagern@gmx.net>
20
20
| Copyright (C) 2009 Hendrik van Antwerpen
21
21
| All rights reserved.
22
22
 
211
211
Investigations are in progress about how to solve this problem,
212
212
probably through the use of caches.
213
213
 
214
 
Limitations
215
 
===========
 
214
Known Problems and Limitations
 
215
==============================
216
216
 
217
217
Bogus changesets
218
218
----------------
268
268
heading) is not supported.  For details see `bug 394204`_, in short this is
269
269
a problem which should be addressed in Trac itself.
270
270
 
271
 
In fact an `upstream bug report`_ is already filled in and a patch is
 
271
In fact an `upstream bug report`_ is already filed in and a patch is
272
272
available, so if you're interested in this feature check it out and discuss
273
273
any issues with it upstream.
274
274
 
275
275
.. _`bug 394204`: https://bugs.launchpad.net/trac-bzr/+bug/394204
276
276
.. _`upstream bug report`: http://trac.edgewall.org/ticket/8919
277
277
 
278
 
File encoding
279
 
-------------
 
278
File content encoding
 
279
---------------------
280
280
Because at the moment Bazaar does not store information about encoding of text 
281
281
files, you may want to change the default character set used by trac. 
282
282
By default trac use encoding iso-8895-15 to show content of your files. 
287
287
  [trac]
288
288
  default_charset = cp1251
289
289
 
 
290
File name encoding
 
291
------------------
 
292
In order to process file names with non-ascii characters, the python
 
293
interpreter must be able to represent these names as paths in the
 
294
local file system. This is still required_ even if the non-ascii name
 
295
occurs only within a treeless branch under some ascii branch name, so
 
296
that the file itself isn't actually present in the file
 
297
system. Different steps might be required to configure the file system
 
298
encoding depending on your operating system and the method you use to
 
299
start trac.
 
300
 
 
301
You can see the configured file system encoding when you look at the
 
302
"System Information" section of the "About Trac" page as a user
 
303
equipped with the `CONFIG_VIEW`_ permission. There you will find an
 
304
entry labeled "FSEncoding" which will tell you what encoding python
 
305
believes_ your file system is using.
 
306
 
 
307
For Trac started as a CGI_ from Apache HTTPD under Linux, you'd use
 
308
the SetEnv_ directive to change the LANG_ environment variable. The
 
309
same approach might work for other combinations as well.
 
310
 
 
311
::
 
312
 
 
313
  LoadModule env_module modules/mod_env.so
 
314
  SetEnv LANG en_US.utf8
 
315
 
 
316
Setting the 'LANG' entry of `os.environ`_ inside the python code used
 
317
to start Trac might work as well, but it might fail in cases where the
 
318
file system encoding is determined and cached before that setting is
 
319
made.
 
320
 
 
321
.. _required: https://bugs.launchpad.net/trac-bzr/+bug/675014/comments/3
 
322
.. _`CONFIG_VIEW`: http://trac.edgewall.org/wiki/TracPermissions
 
323
.. _believes: http://docs.python.org/library/sys.html#sys.getfilesystemencoding
 
324
.. _CGI: http://trac.edgewall.org/wiki/TracCgi
 
325
.. _SetEnv: http://httpd.apache.org/docs/2.2/mod/mod_env.html#setenv
 
326
.. _LANG: http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap08.html#tag_08_02
 
327
.. _`os.environ`: http://docs.python.org/library/os.html#os.environ
 
328
 
290
329
Bazaar plugin
291
330
=============
292
 
There is a Bazaar plugin bundled with this project which can automatically notify trac of new
293
 
commits. To enable this, set the ``trac_project`` option in the Bazaar config to the path
294
 
of your trac environment.
 
331
There is a Bazaar plugin bundled with this project which can
 
332
automatically notify trac of new commits. To enable this, set the
 
333
``trac_project`` option in the Bazaar config to the path of your trac
 
334
environment.
295
335
 
296
 
For example, if your trac environment lives in ``/home/trac/myproject``, run::
 
336
For example, if your trac environment lives in
 
337
``/home/trac/myproject``, run::
297
338
 
298
339
  $ bzr config trac_project=/home/trac/myproject
299
340
 
300
341
in your Bazaar branch.
301
342
 
302
 
This plugin also adds a new bzr subcommand ``bzr close-trac-bugs`` which can automatically
303
 
mark trac bugs as closed based on the Bazaar commit properties created with ``bzr commit --fixes``.
 
343
This plugin also adds a new bzr subcommand ``bzr close-trac-bugs``
 
344
which can automatically mark trac bugs as closed based on the Bazaar
 
345
commit properties created with ``bzr commit --fixes``.
304
346
 
305
347
.. cut long_description here
306
348