changeset 5363:605dbc13eeb7

ini: consistently use single line escaping of ## in template.ini.mako and separate sections by a single empty line
author Mads Kiilerich <madski@unity3d.com>
date Thu, 06 Aug 2015 22:12:30 +0200
parents 24d01c64c5f3
children a478cad966b1
files development.ini kallithea/bin/template.ini.mako kallithea/config/deployment.ini_tmpl test.ini
diffstat 4 files changed, 85 insertions(+), 112 deletions(-) [+]
line wrap: on
line diff
--- a/development.ini	Wed Aug 05 12:29:41 2015 +0200
+++ b/development.ini	Thu Aug 06 22:12:30 2015 +0200
@@ -247,7 +247,6 @@
 #issue_server_link_wiki = https://mywiki.com/{id}
 #issue_prefix_wiki = WIKI-
 
-
 ## instance-id prefix
 ## a prefix key for this instance used for cache invalidation when running
 ## multiple instances of kallithea, make sure it's globally unique for
@@ -269,7 +268,6 @@
 ## allows to setup custom hooks in settings page
 allow_custom_hooks_settings = True
 
-
 ####################################
 ###        CELERY CONFIG        ####
 ####################################
@@ -374,7 +372,6 @@
 ## default cookie expiration time in seconds `true` expire at browser close ##
 #beaker.session.cookie_expires = 3600
 
-
 ############################
 ## ERROR HANDLING SYSTEMS ##
 ############################
@@ -422,7 +419,6 @@
 ## start with HTTP* this list be extended with additional keywords here
 errormator.environ_keys_whitelist =
 
-
 ## list of keywords that should be blanked from request object
 ## can be string with comma separated list of words in lowercase
 ## (by default client will always blank keys that contain following words
@@ -430,13 +426,11 @@
 ## this list be extended with additional keywords set here
 errormator.request_keys_blacklist =
 
-
 ## list of namespaces that should be ignores when gathering log entries
 ## can be string with comma separated list of namespaces
 ## (by default the client ignores own entries: errormator_client.client)
 errormator.log_namespace_blacklist =
 
-
 ################
 ### [sentry] ###
 ################
@@ -455,7 +449,6 @@
 sentry.include_paths =
 sentry.exclude_paths =
 
-
 ################################################################################
 ## WARNING: *THE LINE BELOW MUST BE UNCOMMENTED ON A PRODUCTION ENVIRONMENT*  ##
 ## Debug mode will enable the interactive debugging tool, allowing ANYONE to  ##
--- a/kallithea/bin/template.ini.mako	Wed Aug 05 12:29:41 2015 +0200
+++ b/kallithea/bin/template.ini.mako	Thu Aug 06 22:12:30 2015 +0200
@@ -1,19 +1,19 @@
 ## -*- coding: utf-8 -*-
-<%text>################################################################################
-################################################################################
+<%text>################################################################################</%text>
+<%text>################################################################################</%text>
 # Kallithea - config file generated with kallithea-config                      #
-################################################################################
-################################################################################
-</%text>
+<%text>################################################################################</%text>
+<%text>################################################################################</%text>
+
 [DEFAULT]
 debug = true
 pdebug = false
-<%text>
-################################################################################
-## Uncomment and replace with the address which should receive                ##
-## any error reports after application crash                                  ##
-## Additionally those settings will be used by Kallithea mailing system       ##
-################################################################################</%text>
+
+<%text>################################################################################</%text>
+<%text>## Uncomment and replace with the address which should receive                ##</%text>
+<%text>## any error reports after application crash                                  ##</%text>
+<%text>## Additionally those settings will be used by Kallithea mailing system       ##</%text>
+<%text>################################################################################</%text>
 #email_to = admin@localhost
 #error_email_from = paste_error@localhost
 #app_email_from = kallithea-noreply@localhost
@@ -244,7 +244,6 @@
 #issue_server_link_wiki = https://mywiki.com/{id}
 #issue_prefix_wiki = WIKI-
 
-
 <%text>## instance-id prefix</%text>
 <%text>## a prefix key for this instance used for cache invalidation when running</%text>
 <%text>## multiple instances of kallithea, make sure it's globally unique for</%text>
@@ -266,11 +265,10 @@
 <%text>## allows to setup custom hooks in settings page</%text>
 allow_custom_hooks_settings = True
 
-<%text>
-####################################
-###        CELERY CONFIG        ####
-####################################
-</%text>
+<%text>####################################</%text>
+<%text>###        CELERY CONFIG        ####</%text>
+<%text>####################################</%text>
+
 use_celery = false
 broker.host = localhost
 broker.vhost = rabbitmqhost
@@ -294,11 +292,11 @@
 
 <%text>## tasks will never be sent to the queue, but executed locally instead.</%text>
 celery.always.eager = false
-<%text>
-####################################
-###         BEAKER CACHE        ####
-####################################
-</%text>
+
+<%text>####################################</%text>
+<%text>###         BEAKER CACHE        ####</%text>
+<%text>####################################</%text>
+
 beaker.cache.data_dir=${here}/data/cache/data
 beaker.cache.lock_dir=${here}/data/cache/lock
 
@@ -327,15 +325,15 @@
 beaker.cache.sql_cache_long.type=file
 beaker.cache.sql_cache_long.expire=3600
 beaker.cache.sql_cache_long.key_length = 256
-<%text>
-####################################
-###       BEAKER SESSION        ####
-####################################
-## Type of storage used for the session, current types are
-## dbm, file, memcached, database, and memory.
-## The storage uses the Container API
-## that is also used by the cache system.
-</%text>
+
+<%text>####################################</%text>
+<%text>###       BEAKER SESSION        ####</%text>
+<%text>####################################</%text>
+<%text>## Type of storage used for the session, current types are</%text>
+<%text>## dbm, file, memcached, database, and memory.</%text>
+<%text>## The storage uses the Container API</%text>
+<%text>## that is also used by the cache system.</%text>
+
 <%text>## db session ##</%text>
 #beaker.session.type = ext:database
 #beaker.session.sa.url = postgresql://postgres:qwe@localhost/kallithea
@@ -347,10 +345,8 @@
 <%text>## file based cookies (default) ##</%text>
 #beaker.session.type = file
 
-<%text>
-## beaker.session.key should be unique for a given host, even when running
-## on different ports. Otherwise, cookie sessions will be shared and messed up.
-</%text>
+<%text>## beaker.session.key should be unique for a given host, even when running</%text>
+<%text>## on different ports. Otherwise, cookie sessions will be shared and messed up.</%text>
 beaker.session.key = kallithea
 beaker.session.secret = ${uuid()}
 
@@ -374,19 +370,19 @@
 #beaker.session.cookie_expires = 3600
 
 %if error_aggregation_service == 'errormator':
-<%text>
-############################
-## ERROR HANDLING SYSTEMS ##
-############################
+
+<%text>############################</%text>
+<%text>## ERROR HANDLING SYSTEMS ##</%text>
+<%text>############################</%text>
 
-####################
-### [errormator] ###
-####################
+<%text>####################</%text>
+<%text>### [errormator] ###</%text>
+<%text>####################</%text>
 
-## Errormator is tailored to work with Kallithea, see
-## http://errormator.com for details how to obtain an account
-## you must install python package `errormator_client` to make it work
-</%text>
+<%text>## Errormator is tailored to work with Kallithea, see</%text>
+<%text>## http://errormator.com for details how to obtain an account</%text>
+<%text>## you must install python package `errormator_client` to make it work</%text>
+
 <%text>## errormator enabled</%text>
 errormator = false
 
@@ -422,7 +418,6 @@
 <%text>## start with HTTP* this list be extended with additional keywords here</%text>
 errormator.environ_keys_whitelist =
 
-
 <%text>## list of keywords that should be blanked from request object</%text>
 <%text>## can be string with comma separated list of words in lowercase</%text>
 <%text>## (by default client will always blank keys that contain following words</%text>
@@ -430,20 +425,19 @@
 <%text>## this list be extended with additional keywords set here</%text>
 errormator.request_keys_blacklist =
 
-
 <%text>## list of namespaces that should be ignores when gathering log entries</%text>
 <%text>## can be string with comma separated list of namespaces</%text>
 <%text>## (by default the client ignores own entries: errormator_client.client)</%text>
 errormator.log_namespace_blacklist =
 %elif error_aggregation_service == 'sentry':
-<%text>
-################
-### [sentry] ###
-################
 
-## sentry is a alternative open source error aggregator
-## you must install python packages `sentry` and `raven` to enable
-</%text>
+<%text>################</%text>
+<%text>### [sentry] ###</%text>
+<%text>################</%text>
+
+<%text>## sentry is a alternative open source error aggregator</%text>
+<%text>## you must install python packages `sentry` and `raven` to enable</%text>
+
 sentry.dsn = YOUR_DNS
 sentry.servers =
 sentry.name =
@@ -455,26 +449,26 @@
 sentry.include_paths =
 sentry.exclude_paths =
 %endif
-<%text>
-################################################################################
-## WARNING: *THE LINE BELOW MUST BE UNCOMMENTED ON A PRODUCTION ENVIRONMENT*  ##
-## Debug mode will enable the interactive debugging tool, allowing ANYONE to  ##
-## execute malicious code after an exception is raised.                       ##
-################################################################################</%text>
+
+<%text>################################################################################</%text>
+<%text>## WARNING: *THE LINE BELOW MUST BE UNCOMMENTED ON 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
-<%text>
-##################################
-###       LOGVIEW CONFIG       ###
-##################################
-</%text>
+
+<%text>##################################</%text>
+<%text>###       LOGVIEW CONFIG       ###</%text>
+<%text>##################################</%text>
+
 logview.sqlalchemy = #faa
 logview.pylons.templating = #bfb
 logview.pylons.util = #eee
-<%text>
-#########################################################
-### DB CONFIGS - EACH DB WILL HAVE IT'S OWN CONFIG    ###
-#########################################################
-</%text>
+
+<%text>#########################################################</%text>
+<%text>### DB CONFIGS - EACH DB WILL HAVE IT'S OWN CONFIG    ###</%text>
+<%text>#########################################################</%text>
+
 %if database_engine == 'sqlite':
 # SQLITE [default]
 sqlalchemy.db1.url = sqlite:///${here}/kallithea.db?timeout=60
@@ -490,11 +484,11 @@
 sqlalchemy.db1.echo = false
 sqlalchemy.db1.pool_recycle = 3600
 sqlalchemy.db1.convert_unicode = true
-<%text>
-################################
-### LOGGING CONFIGURATION   ####
-################################
-</%text>
+
+<%text>################################</%text>
+<%text>### LOGGING CONFIGURATION   ####</%text>
+<%text>################################</%text>
+
 [loggers]
 keys = root, routes, kallithea, sqlalchemy, beaker, templates, whoosh_indexer
 
@@ -503,11 +497,11 @@
 
 [formatters]
 keys = generic, color_formatter, color_formatter_sql
-<%text>
-#############
-## LOGGERS ##
-#############
-</%text>
+
+<%text>#############</%text>
+<%text>## LOGGERS ##</%text>
+<%text>#############</%text>
+
 [logger_root]
 level = NOTSET
 handlers = console
@@ -548,11 +542,11 @@
 handlers =
 qualname = whoosh_indexer
 propagate = 1
-<%text>
-##############
-## HANDLERS ##
-##############
-</%text>
+
+<%text>##############</%text>
+<%text>## HANDLERS ##</%text>
+<%text>##############</%text>
+
 [handler_console]
 class = StreamHandler
 args = (sys.stderr,)
@@ -564,11 +558,11 @@
 args = (sys.stderr,)
 level = WARN
 formatter = generic
-<%text>
-################
-## FORMATTERS ##
-################
-</%text>
+
+<%text>################</%text>
+<%text>## FORMATTERS ##</%text>
+<%text>################</%text>
+
 [formatter_generic]
 format = %(asctime)s.%(msecs)03d %(levelname)-5.5s [%(name)s] %(message)s
 datefmt = %Y-%m-%d %H:%M:%S
--- a/kallithea/config/deployment.ini_tmpl	Wed Aug 05 12:29:41 2015 +0200
+++ b/kallithea/config/deployment.ini_tmpl	Thu Aug 06 22:12:30 2015 +0200
@@ -241,7 +241,6 @@
 #issue_server_link_wiki = https://mywiki.com/{id}
 #issue_prefix_wiki = WIKI-
 
-
 ## instance-id prefix
 ## a prefix key for this instance used for cache invalidation when running
 ## multiple instances of kallithea, make sure it's globally unique for
@@ -263,7 +262,6 @@
 ## allows to setup custom hooks in settings page
 allow_custom_hooks_settings = True
 
-
 ####################################
 ###        CELERY CONFIG        ####
 ####################################
@@ -368,7 +366,6 @@
 ## default cookie expiration time in seconds `true` expire at browser close ##
 #beaker.session.cookie_expires = 3600
 
-
 ############################
 ## ERROR HANDLING SYSTEMS ##
 ############################
@@ -416,7 +413,6 @@
 ## start with HTTP* this list be extended with additional keywords here
 errormator.environ_keys_whitelist =
 
-
 ## list of keywords that should be blanked from request object
 ## can be string with comma separated list of words in lowercase
 ## (by default client will always blank keys that contain following words
@@ -424,13 +420,11 @@
 ## this list be extended with additional keywords set here
 errormator.request_keys_blacklist =
 
-
 ## list of namespaces that should be ignores when gathering log entries
 ## can be string with comma separated list of namespaces
 ## (by default the client ignores own entries: errormator_client.client)
 errormator.log_namespace_blacklist =
 
-
 ################
 ### [sentry] ###
 ################
@@ -449,7 +443,6 @@
 sentry.include_paths =
 sentry.exclude_paths =
 
-
 ################################################################################
 ## WARNING: *THE LINE BELOW MUST BE UNCOMMENTED ON A PRODUCTION ENVIRONMENT*  ##
 ## Debug mode will enable the interactive debugging tool, allowing ANYONE to  ##
--- a/test.ini	Wed Aug 05 12:29:41 2015 +0200
+++ b/test.ini	Thu Aug 06 22:12:30 2015 +0200
@@ -247,7 +247,6 @@
 #issue_server_link_wiki = https://mywiki.com/{id}
 #issue_prefix_wiki = WIKI-
 
-
 ## instance-id prefix
 ## a prefix key for this instance used for cache invalidation when running
 ## multiple instances of kallithea, make sure it's globally unique for
@@ -269,7 +268,6 @@
 ## allows to setup custom hooks in settings page
 allow_custom_hooks_settings = True
 
-
 ####################################
 ###        CELERY CONFIG        ####
 ####################################
@@ -374,7 +372,6 @@
 ## default cookie expiration time in seconds `true` expire at browser close ##
 #beaker.session.cookie_expires = 3600
 
-
 ############################
 ## ERROR HANDLING SYSTEMS ##
 ############################
@@ -422,7 +419,6 @@
 ## start with HTTP* this list be extended with additional keywords here
 errormator.environ_keys_whitelist =
 
-
 ## list of keywords that should be blanked from request object
 ## can be string with comma separated list of words in lowercase
 ## (by default client will always blank keys that contain following words
@@ -430,13 +426,11 @@
 ## this list be extended with additional keywords set here
 errormator.request_keys_blacklist =
 
-
 ## list of namespaces that should be ignores when gathering log entries
 ## can be string with comma separated list of namespaces
 ## (by default the client ignores own entries: errormator_client.client)
 errormator.log_namespace_blacklist =
 
-
 ################
 ### [sentry] ###
 ################
@@ -455,7 +449,6 @@
 sentry.include_paths =
 sentry.exclude_paths =
 
-
 ################################################################################
 ## WARNING: *THE LINE BELOW MUST BE UNCOMMENTED ON A PRODUCTION ENVIRONMENT*  ##
 ## Debug mode will enable the interactive debugging tool, allowing ANYONE to  ##