kallithea Changeset - fc6b1b0e1096

Changeset - fc6b1b0e1096

Parent rev.

Child rev.

[Not reviewed]

default

0 4 0

Thomas De Schampheleire - 9 years ago 2017-01-27 21:31:37
thomas.de.schampheleire@gmail.com

ini: set 'debug' only in one place

In Pylons-based Kallithea, the 'debug' option was set first in [DEFAULTS]
and then overridden with 'set debug = X' in [app:main]. Even when the value
under [DEFAULTS] was commented out, the use of the 'set' keyword (providing
override semantics) was required, because a default value for the global
'debug' was provided in the framework.

The presence of these two debug assignments is confusing.
Moreover, TurboGears2 makes the situation more easy and does not expect
'debug' to be in [DEFAULTS] nor does it provide a default at that level.
As a result, we can simple use 'debug = X' under [app:main].

Additionally, clarify the Big Fat Warning: the wording 'the line below' is
ambiguous and could be misunderstood in an ini file that had previously been
changed.

4 files changed with 10 insertions and 13 deletions:

development.ini

kallithea/lib/paster_commands/template.ini.mako

kallithea/tests/test.ini

scripts/generate-ini.py

0 comments (0 inline, 0 general)

development.ini

➞

Show inline comments

 ################################################################################
 ################################################################################
 # Kallithea - Development config:                                              #
 # listening on *:5000                                                          #
 # sqlite and kallithea.db                                                      #
 # initial_repo_scan = true                                                     #
-# set debug = true                                                             #
+# debug = true                                                                 #
 # verbose and colorful logging                                                 #
 #                                                                              #
 # The %(here)s variable will be replaced with the parent directory of this file#
 ################################################################################
 ################################################################################
 [DEFAULT]
 debug = true
 ################################################################################
 ## Email settings                                                             ##
 ##                                                                            ##
 ## Refer to the documentation ("Email settings") for more details.            ##
 ##                                                                            ##
@@ @@ -463,18 +462,18 @@ sentry.secret_key = @@
 sentry.project =
 sentry.site =
 sentry.include_paths =
 sentry.exclude_paths =
 ################################################################################
-## WARNING: *THE LINE BELOW MUST BE UNCOMMENTED ON A PRODUCTION ENVIRONMENT*  ##
+## WARNING: *DEBUG MODE MUST BE OFF IN A PRODUCTION ENVIRONMENT*              ##
 ## Debug mode will enable the interactive debugging tool, allowing ANYONE to  ##
 ## execute malicious code after an exception is raised.                       ##
 ################################################################################
 #set debug = false
 set debug = true
 #debug = false
 debug = true
 ##################################
 ###       LOGVIEW CONFIG       ###
 ##################################
 logview.sqlalchemy = #faa

kallithea/lib/paster_commands/template.ini.mako

➞

Show inline comments

@@ @@ -3,13 +3,12 @@ @@
 <%text>################################################################################</%text>
 # Kallithea - config file generated with kallithea-config                      #
 <%text>################################################################################</%text>
 <%text>################################################################################</%text>
 [DEFAULT]
 debug = true
 <%text>################################################################################</%text>
 <%text>## Email settings                                                             ##</%text>
 <%text>##                                                                            ##</%text>
 <%text>## Refer to the documentation ("Email settings") for more details.            ##</%text>
 <%text>##                                                                            ##</%text>
@@ @@ -464,17 +463,17 @@ sentry.project = @@
 sentry.site =
 sentry.include_paths =
 sentry.exclude_paths =
 %endif
 <%text>################################################################################</%text>
-<%text>## WARNING: *THE LINE BELOW MUST BE UNCOMMENTED ON A PRODUCTION ENVIRONMENT*  ##</%text>
+<%text>## WARNING: *DEBUG MODE MUST BE OFF IN A PRODUCTION ENVIRONMENT*              ##</%text>
 <%text>## Debug mode will enable the interactive debugging tool, allowing ANYONE to  ##</%text>
 <%text>## execute malicious code after an exception is raised.                       ##</%text>
 <%text>################################################################################</%text>
-set debug = false
 debug = false
 <%text>##################################</%text>
 <%text>###       LOGVIEW CONFIG       ###</%text>
 <%text>##################################</%text>
 logview.sqlalchemy = #faa

kallithea/tests/test.ini

➞

Show inline comments

@@ @@ -7,13 +7,12 @@ @@
 #                                                                              #
 # The %(here)s variable will be replaced with the parent directory of this file#
 ################################################################################
 ################################################################################
 [DEFAULT]
 debug = true
 ################################################################################
 ## Email settings                                                             ##
 ##                                                                            ##
 ## Refer to the documentation ("Email settings") for more details.            ##
 ##                                                                            ##
@@ @@ -468,17 +467,17 @@ sentry.secret_key = @@
 sentry.project =
 sentry.site =
 sentry.include_paths =
 sentry.exclude_paths =
 ################################################################################
-## WARNING: *THE LINE BELOW MUST BE UNCOMMENTED ON A PRODUCTION ENVIRONMENT*  ##
+## WARNING: *DEBUG MODE MUST BE OFF IN A PRODUCTION ENVIRONMENT*              ##
 ## Debug mode will enable the interactive debugging tool, allowing ANYONE to  ##
 ## execute malicious code after an exception is raised.                       ##
 ################################################################################
-set debug = false
 debug = false
 ##################################
 ###       LOGVIEW CONFIG       ###
 ##################################
 logview.sqlalchemy = #faa

scripts/generate-ini.py

➞

Show inline comments

@@ @@ -69,24 +69,24 @@ ini_files = [ @@
     ('development.ini',
         '''
         Kallithea - Development config:
         listening on *:5000
         sqlite and kallithea.db
         initial_repo_scan = true
-        set debug = true
         debug = true
         verbose and colorful logging
         The %(here)s variable will be replaced with the parent directory of this file
         ''',
+        {
             '[server:main]': {
                 'host': '0.0.0.0',
             },
             '[app:main]': {
                 'initial_repo_scan': 'true',
-                'set debug': 'true',
                 'debug': 'true',
                 'app_instance_uuid': 'development-not-secret',
                 'beaker.session.secret': 'development-not-secret',
             },
             '[handler_console]': {
                 'level': 'DEBUG',
                 'formatter': 'color_formatter',

0 comments (0 inline, 0 general)