Doc additions.

This commit is contained in:
Joshua Harlow
2012-01-22 00:27:07 -08:00
parent ded561aedd
commit 3bc348ff2b

View File

@@ -6,17 +6,24 @@
# localhost will be used instead.
#
# We also allow for simple referencing of other variables, similar to bash
# variables to occur when a keys value like the following format are found:
# variables to occur when a keys value like the following format are found:
#
# ${RUNNING_HOST:-http://$(X:Y)}
# web_host = ${RUNNING_HOST:-http://$(X:Y)}
#
# For this example, the RUNNING_HOST enviroment variable will be referenced.
# If it is not found (no value exists), then "http://$(X:Y)" will be
# examined and found to be contain a expression (denoted by "$()").
# Then in that expression if there are components of the format "X:Y" then the
# examined and found to be contain a expression (denoted by "$(X:Y)").
# Then in that expression there are components of the format "X:Y" which the
# configuration class will attempt to resolve those values by looking up in the
# configuration file for a value in section "X" with name "Y" and replacing the
# retrieved value for what was previously "$(X:Y)"
# configuration file for a value in section "X" with option "Y" and replacing the
# retrieved value for what was previously "$(X:Y)". Multiple of these "expressions"
# are allowed and each will have its expression "text" replaced with the resolved
# value before the final value for the original variable is determined.
#
# For this example if the section X with option Y contained value "1.2.3.4" then
# the final string would be "http://1.2.3.4" which would then be cached as the value
# for option web_host.
[default]