Add <config:format> to avoid breaking existing configuration files with XML entity changes

git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@11974 e03df62e-2008-0410-955e-edbf42e46eb7

1 files changed, 5 insertions, 0 deletions

diff --git a/conf/inspircd.conf.example b/conf/inspircd.conf.example
index d5c9874df..47ecd5889 100644
--- a/conf/inspircd.conf.example
+++ b/conf/inspircd.conf.example
@@ -71,6 +71,10 @@
 # Variables may be redefined and may reference other variables.       #
 # Value expansion happens at the time the tag is read.                #
 #                                                                     #
+# Using variable definitions REQUIRES that the config format be       #
+# changed to "xml" from the default "compat" that uses escape         #
+# sequences such as "\"" and "\n", and does not support <define>      #
+<config format="xml">
 <define name="bindip" value="1.2.2.3">
 <define name="localips" value="&bindip;/24">
 
@@ -478,6 +482,7 @@
          # prefixpart: What (if anything) a users' part message
          # should be prefixed with.
          prefixpart="&quot;"
+         # NOTE: Use "\"" instead of "&quot;" if not using <config format="xml">
 
          # suffixpart: What (if anything) a users' part message
          # should be suffixed with.