improve comments in sample config file

1 files changed, 44 insertions, 48 deletions

diff --git a/docs/rabbitmq.sample.config b/docs/rabbitmq.sample.config
index 2c7029614d..0f2272e6af 100644
--- a/docs/rabbitmq.sample.config
+++ b/docs/rabbitmq.sample.config
@@ -12,34 +12,36 @@
            %% Configure AMQP to listen on ports.
            %% {tcp_listeners, [5672, 5673]},
 
-           %% Configure SSL (AMQP) to listen on ports.
+           %% Socket options.
+           %%
+           %% See (http://www.erlang.org/doc/man/inet.html#setopts-2) for
+           %% further documentation.
+           %%
+           %% {tcp_listen_options, [binary,
+           %%                       {packet,        raw},
+           %%                       {reuseaddr,     true},
+           %%                       {backlog,       128},
+           %%                       {nodelay,       true},
+           %%                       {exit_on_close, false}]},
+
+		   %% Configure SSL to listen on ports.
            %% {ssl_listeners, [5674, 5675]},
 
-           %% SSL options.
-           %%
+           %% SSL options (see http://www.rabbitmq.com/ssl.html).
            %% {ssl_options, [{cacertfile,"/path/to/testca/cacert.pem"},
            %%                {certfile,"/path/to/server/cert.pem"},
            %%                {keyfile,"/path/to/server/key.pem"},
            %%                {verify, verify_peer},
            %%                {fail_if_no_peer_cert, true}]},
 
-           %% Frame Max (in bytes).
+           %% Max permissible size of a frame (in bytes).
            %% {frame_max, 131072},
 
            %% Heartbeat delay (in seconds).
            %% {heartbeat, 600},
 
-           %% Socket options.
-           %%
-           %% See (http://www.erlang.org/doc/man/inet.html#setopts-2) for
-           %% further documentation.
-           %%
-           %% {tcp_listen_options, [binary,
-           %%                       {packet,        raw},
-           %%                       {reuseaddr,     true},
-           %%                       {backlog,       128},
-           %%                       {nodelay,       true},
-           %%                       {exit_on_close, false}]},
+           %% Let the log level for connection logging.
+           %% {log_levels, [{connection, info}]},
 
            %%
            %% Security/AAA & Default VHost/User
@@ -54,7 +56,7 @@
            %% Set Available authentication databases.
            %% {auth_backends, [rabbit_auth_backend_internal]},
 
-           %% To enable the LDAP backend.
+           %% Or to enable the LDAP backend.
            %% {auth_backends, [rabbit_auth_backend_ldap]},
 
            %% Virtual host to create on first start.
@@ -75,6 +77,8 @@
            %%
            %% Resource Limits & Flow Control
            %%
+		   %% See http://www.rabbitmq.com/memory.html for more details.
+		   %%
 
            %% Memory-based Flow Control threshold.
            %% {vm_memory_high_watermark, 0.4},
@@ -85,8 +89,8 @@
            %% Alternatively, set disk free limit relative to total RAM.
            %% {disk_free_limit, {mem_relative, 1.0}},
 
-           %% Log levels.
-           %% {log_levels, [{connection, info}]},
+           %% Override file handle limits.
+           %% {file_handles_high_watermark, 10000000},
 
            %%
            %% Misc/Advanced Options:
@@ -111,19 +115,11 @@
            %% {cluster_nodes, {['rabbit@my.host.com'], disc}},
 
            %% Set (internal) statistics collection granularity.
-           %%
-           %% - none: disables statistics events
-           %% - coarse: emit stats per queue, channel and connection
-           %% - fine: also emit per-message stats
-           %%
            %% {collect_statistics, none},
 
            %% Statistics collection interval (in milliseconds).
            %% {collect_statistics_interval, 5000},
 
-           %% Override file handle limits.
-           %% {file_handles_high_watermark, 10000000},
-
            %% Explicitly enable/disable hipe compilation.
            %% {hipe_compile, true},
 
@@ -166,7 +162,7 @@
  %% ----------------------------------------------------------------------------
 
  {rabbitmq_shovel,
-  [{shovels, [%% A named shovel worker
+  [{shovels, [%% A named shovel worker.
               %% {my_first_shovel,
               %%  [{sources,
               %%    [{brokers, [
@@ -206,8 +202,8 @@
                    %% Overwrite fields of the outbound basic.publish.
               %%   {publish_fields, []},
 
-                   %% the number of seconds to wait before attempting to
-                   %% reconnect in the event of a connection failure
+                   %% The number of seconds to wait before attempting to
+                   %% reconnect in the event of a connection failure.
               %%   {reconnect_delay, 2.5}
                ]}
              ]},
@@ -228,7 +224,7 @@
                    %% Extract name from client's certificate when using SSL.
                    %% {ssl_cert_login, true},
 
-                   %% Use cn instead of dn when reading from the SSL cert
+                   %% Use cn instead of dn when reading from the SSL cert.
                    %%                , {ssl_cert_login_from, common_name}.
 
                    %% Set a default user and password.
@@ -242,30 +238,30 @@
  %% See http://hg.rabbitmq.com/rabbitmq-mqtt/file/stable/README.md for details
  %% ----------------------------------------------------------------------------
 
- {rabbitmq_mqtt, [%% Set the default user name and password
+ {rabbitmq_mqtt, [%% Set the default user name and password.
                   %% {default_user, <<"guest">>},
                   %% {default_pass, <<"guest">>},
 
-                  %% Enable anonymous access
+                  %% Enable anonymous access.
                   %% {allow_anonymous, true},
 
-                  %% Specify the vhost
+                  %% Specify the vhost.
                   %% {vhost, <<"/">>},
 
-                  %% Specify the exchange
+                  %% Specify the exchange.
                   %% {exchange, <<"amq.topic">>},
 
-                  %% Specify TTL for subscriptions
+                  %% Specify TTL for subscriptions.
                   %% {subscription_ttl, 1800000},
 
-                  %% Set prefetch count
+                  %% Set prefetch count.
                   %% {prefetch, 10},
 
-                  %% TCP/SSL Configuration
+                  %% TCP/SSL Configuration.
                   %% {ssl_listeners, []},
                   %% {tcp_listeners,    [1883]},
 
-                  %% TCP/Socket options
+                  %% TCP/Socket options.
                   %% {tcp_listen_options, [binary,
                   %%                       {packet,    raw},
                   %%                       {reuseaddr, true},
@@ -280,10 +276,10 @@
  %% for details
  %% ----------------------------------------------------------------------------
 
- {rabbitmq_amqp1_0, [%% Set the default user
+ {rabbitmq_amqp1_0, [%% Set the default user.
                      %% {default_user, "guest"},
 
-                     %% Enable protocol strict mode
+                     %% Enable protocol strict mode.
                      %% {protocol_strict_mode, false}
                     ]},
 
@@ -295,29 +291,29 @@
  %% ----------------------------------------------------------------------------
 
  {rabbitmq_auth_backend_ldap,
-  [%% Specify a list of LDAP Servers
+  [%% Specify a list of LDAP Servers.
    %% {servers, []},
 
-   %% Set user DN pattern
+   %% Set user DN pattern.
    %% {user_dn_pattern, "cn=${username},ou=People,dc=example,dc=com"},
 
-   %% Enable SSL
+   %% Enable SSL.
    %% {use_ssl, false},
 
-   %% Specify the LDAP port
+   %% Specify the LDAP port.
    %% {port, 389},
 
-   %% Enable logging
+   %% Enable logging.
    %% {log, false},
 
-   %% Set vhost access query
+   %% Set vhost access query.
    %% {vhost_access_query, {in_group
    %%                        "ou=${vhost}-users,ou=vhosts,dc=example,dc=com"}},
 
-   %% Set resource access query
+   %% Set resource access query.
    %% {resource_access_query, {constant, true}},
 
-   %% Set tag queries
+   %% Set tag queries.
    %% {tag_queries, []}
   ]}
 ].