QPID-4881: update docs/help to use quotes for the config property argument, as will be required when using the startup script on Windows

git-svn-id: https://svn.apache.org/repos/asf/qpid/trunk@1486017 13f79535-47bb-0310-9956-ffa450edef68

3 files changed, 8 insertions, 9 deletions

diff --git a/qpid/doc/book/src/java-broker/Java-Broker-Configuring-And-Managing-Config-Files.xml b/qpid/doc/book/src/java-broker/Java-Broker-Configuring-And-Managing-Config-Files.xml
index 8dfb8de5c1..072effa798 100644
--- a/qpid/doc/book/src/java-broker/Java-Broker-Configuring-And-Managing-Config-Files.xml
+++ b/qpid/doc/book/src/java-broker/Java-Broker-Configuring-And-Managing-Config-Files.xml
@@ -278,7 +278,7 @@ $ ./qpid-server -st memory
         </para>
 
         <screen>
-$ ./qpid-server -prop qpid.amqp_port=10000 -prop qpid.http_port=10001
+$ ./qpid-server -prop "qpid.amqp_port=10000" -prop "qpid.http_port=10001"
         </screen>
         <para>
             In the example above, property used to set the port number of the default AMQP port is specified with the value 10000, overriding the default value of 5672, and similarly the vlaue 10001 is used to override the default HTTP port number of 8080.
@@ -289,10 +289,9 @@ $ ./qpid-server -prop qpid.amqp_port=10000 -prop qpid.http_port=10001
             NOTE: when saving the broker Configuration Store, either during initialisation when generating any required IDs for the 'Initial Configuration', or when required following user-prompted change via the managmenet interface, values are
             stored in their resolved state. As such, if a Configuration Store already exists when the broker is started, it is likely that setting a Configuration Property to a value different than it was previously set could have no effect.
         </para>
-
-
-
-
+        <para>
+            NOTE: When running the broker on Windows and starting it via the qpid-server.bat file, the "name=value" argument MUST be quoted.
+        </para>
 
     </section>
 
diff --git a/qpid/doc/book/src/java-broker/Java-Broker-Getting-Started.xml b/qpid/doc/book/src/java-broker/Java-Broker-Getting-Started.xml
index bb79baf358..d597cf1aeb 100644
--- a/qpid/doc/book/src/java-broker/Java-Broker-Getting-Started.xml
+++ b/qpid/doc/book/src/java-broker/Java-Broker-Getting-Started.xml
@@ -152,10 +152,10 @@
  -os                                            Overwrite the broker configuration store
  --overwrite-store                              with the current initial configuration
 
- -prop <name=value>                             Set a configuration property to use when
- --config-property <name=value>                 resolving variables in the broker
+ -prop "<name=value>"                           Set a configuration property to use when
+ --config-property "<name=value>"               resolving variables in the broker
                                                 configuration store, with format
-                                                'name=value'
+                                                "name=value"
 
  -sp <path>                                     Use given configuration store location
  --store-path <path>
diff --git a/qpid/java/broker/src/main/java/org/apache/qpid/server/Main.java b/qpid/java/broker/src/main/java/org/apache/qpid/server/Main.java
index 3f6c3e7f78..20b73e965c 100644
--- a/qpid/java/broker/src/main/java/org/apache/qpid/server/Main.java
+++ b/qpid/java/broker/src/main/java/org/apache/qpid/server/Main.java
@@ -61,7 +61,7 @@ public class Main
             .withLongOpt("create-initial-config").create("cic");
 
     private static final Option OPTION_CONFIGURATION_PROPERTY = OptionBuilder.withArgName("name=value").hasArg()
-            .withDescription("set a configuration property to use when resolving variables in the broker configuration store, with format 'name=value'")
+            .withDescription("set a configuration property to use when resolving variables in the broker configuration store, with format \"name=value\"")
             .withLongOpt("config-property").create("prop");
 
     private static final Option OPTION_LOG_CONFIG_FILE =