changeset 806:b62562828364

Improved documentation for the quick-status in navigation. See performance discussion at #536.
author osimons
date Thu, 26 Aug 2010 23:20:35 +0000
parents 4c73a3cea9f5
children 780a86f0a3f1
files bitten/master.py
diffstat 1 files changed, 5 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/bitten/master.py
+++ b/bitten/master.py
@@ -70,8 +70,11 @@
          """The directory on the server in which client log files will be stored.""")
 
     quick_status = BoolOption('bitten', 'quick_status', False, doc=
-         """Whether to show the current build status withing the Trac main
-            navigation bar""")
+         """Whether to show the current build status within the Trac main
+            navigation bar. '''Note:''' The feature requires expensive database and
+            repository checks for every page request, and should not be enabled
+            if the project has a large repository or uses a non-Subversion
+            repository such as Mercurial or Git.""")
 
     def __init__(self):
         self.env.systeminfo.append(('Bitten',
Copyright (C) 2012-2017 Edgewall Software