[couchdb] branch master updated: Improve vm.args template comments (#1861)

[wo...@apache.org]

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

wohali pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/couchdb.git


The following commit(s) were added to refs/heads/master by this push:
     new 38c1ab4  Improve vm.args template comments (#1861)
38c1ab4 is described below

commit 38c1ab47446031addc4ace180aa3669a4d0b010a
Author: Joan Touzet <wo...@users.noreply.github.com>
AuthorDate: Tue Jan 15 13:36:38 2019 -0500

    Improve vm.args template comments (#1861)
---
 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.