summaryrefslogtreecommitdiffstats
path: root/defaults
diff options
context:
space:
mode:
authorArne Juul <arnej@yahoo-inc.com>2018-05-22 13:44:48 +0000
committerArne Juul <arnej@yahoo-inc.com>2018-05-22 13:44:48 +0000
commit258bec0a21196a15012d0311dde896c2e01bc95f (patch)
tree8d6f643e8a6f77b6124bef1484d8409fd9987e67 /defaults
parentc755ec751ac75625859188225184e80b2caf504e (diff)
update documentation comments
Diffstat (limited to 'defaults')
-rw-r--r--defaults/src/main/java/com/yahoo/vespa/defaults/Defaults.java5
-rw-r--r--defaults/src/vespa/defaults.h5
2 files changed, 8 insertions, 2 deletions
diff --git a/defaults/src/main/java/com/yahoo/vespa/defaults/Defaults.java b/defaults/src/main/java/com/yahoo/vespa/defaults/Defaults.java
index 441773a14c9..af92a183443 100644
--- a/defaults/src/main/java/com/yahoo/vespa/defaults/Defaults.java
+++ b/defaults/src/main/java/com/yahoo/vespa/defaults/Defaults.java
@@ -90,7 +90,10 @@ public class Defaults {
/**
- * Compute the host name that identifies myself
+ * Compute the host name that identifies myself.
+ * Detection of the hostname is now done before starting any Vespa
+ * programs and provided in the environment variable VESPA_HOSTNAME;
+ * if that variable isn't set a default of "localhost" is always returned.
* @return the vespa host name
**/
public String vespaHostname() { return vespaHost; }
diff --git a/defaults/src/vespa/defaults.h b/defaults/src/vespa/defaults.h
index d0b400ef563..c52a4511f4e 100644
--- a/defaults/src/vespa/defaults.h
+++ b/defaults/src/vespa/defaults.h
@@ -34,7 +34,10 @@ public:
static const char *vespaUser();
/**
- * Compute the host name that identifies myself
+ * Compute the host name that identifies myself.
+ * Detection of the hostname is now done before starting any Vespa
+ * programs and provided in the environment variable VESPA_HOSTNAME;
+ * if that variable isn't set a default of "localhost" is always returned.
* @return the vespa host name
**/
static const char *vespaHostname();