[couchdb] 01/01: Improve vm.args template comments

[wo...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

wohali pushed a commit to branch 375-improve-vm-args
in repository https://gitbox.apache.org/repos/asf/couchdb.git

commit c11402e0c97b6599ac7e02eae36da876bf320ca3
Author: Joan Touzet <jo...@atypical.net>
AuthorDate: Tue Jan 15 12:35:29 2019 -0500

    Improve vm.args template comments
---
 rel/overlay/etc/vm.args | 15 ++++++++++++---
 1 file changed, 12 insertions(+), 3 deletions(-)

diff --git a/rel/overlay/etc/vm.args b/rel/overlay/etc/vm.args
index e9f0737..86b51f8 100644
--- a/rel/overlay/etc/vm.args
+++ b/rel/overlay/etc/vm.args
@@ -11,18 +11,27 @@
 # the License.
 
 # Each node in the system must have a unique name. These are specified through
-# the Erlang -name flag, which takes the form nodename@hostname. CouchDB
-# recommends the following values for this flag:
+# the Erlang -name flag, which takes the form:
+#
+#    -name nodename@<FQDN>
+#
+# or
+#
+#    -name nodename@<IP-ADDRESS>
+#
+# CouchDB recommends the following values for this flag:
 #
 # 1. If this is a single node, not in a cluster, use:
 #    -name couchdb@127.0.0.1
+#
 # 2. If DNS is configured for this host, use the FQDN, such as:
 #    -name couchdb@my.host.domain.com
+#
 # 3. If DNS isn't configured for this host, use IP addresses only, such as:
 #    -name couchdb@192.168.0.1
 #
 # Do not rely on tricks with /etc/hosts or libresolv to handle anything
-# other than the above 3 approaches correctly.
+# other than the above 3 approaches correctly. They will not work reliably.
 #
 # Multiple CouchDBs running on the same machine can use couchdb1@, couchdb2@,
 # etc.