summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStephen Finucane <sfinucan@redhat.com>2020-05-01 16:10:30 +0100
committerBen Nemec <openstack@nemebean.com>2020-05-01 16:04:34 +0000
commitdf5e5db191c13198a12b3eb24f0eda603e3324d8 (patch)
tree7b33f1fcfecc058d7ceb7764f639f8786177b52d
parent579a323a43a7f6fdacc3766a1b4b994ceffc6771 (diff)
downloadoslo-config-df5e5db191c13198a12b3eb24f0eda603e3324d8.tar.gz
docs: Mention other ways of escaping '$'
oslo config code treat treats the '$' as a special character and it needs to be delimited when using within a string. There are two ways of doing this, '$$' or '\$'. We document the former but not the latter. Fix this. Change-Id: I37cdf31ba1c2924779a46b1a2eeabb66c46a2212 Signed-off-by: Stephen Finucane <sfinucan@redhat.com> Closes-Bug: #1872839
-rw-r--r--doc/source/configuration/format.rst2
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/source/configuration/format.rst b/doc/source/configuration/format.rst
index 9254a1e..7467117 100644
--- a/doc/source/configuration/format.rst
+++ b/doc/source/configuration/format.rst
@@ -155,7 +155,7 @@ option, in this case as ``controller:5672``.
# RabbitMQ HA cluster host:port pairs. (list value)
rabbit_hosts = $rabbit_host:$rabbit_port
-To avoid substitution, use ``$$``, it is replaced by a single ``$``.
+To avoid substitution, escape the ``$`` with ``$$`` or ``\$``.
For example, if your LDAP DNS password is ``$xkj432``, specify it, as follows:
.. code-block:: ini