diff options
author | Henning Baldersheim <balder@yahoo-inc.com> | 2018-06-04 13:53:39 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2018-06-04 13:53:39 +0200 |
commit | 07c5fb4af743bea778d1e42c22412cc93afa42d2 (patch) | |
tree | 41abc83ba335fb032b2964ea25f29917e5606c9c | |
parent | 4041b5ad7f9e1d1ee1acc1a1db055089a48bcfc4 (diff) | |
parent | 258bec0a21196a15012d0311dde896c2e01bc95f (diff) |
Merge pull request #6067 from vespa-engine/arnej/update-javadoc
update documentation comments
-rw-r--r-- | defaults/src/main/java/com/yahoo/vespa/defaults/Defaults.java | 5 | ||||
-rw-r--r-- | defaults/src/vespa/defaults.h | 5 | ||||
-rw-r--r-- | vespajlib/src/main/java/com/yahoo/net/HostName.java | 3 |
3 files changed, 11 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(); diff --git a/vespajlib/src/main/java/com/yahoo/net/HostName.java b/vespajlib/src/main/java/com/yahoo/net/HostName.java index 9a48c82c369..0982373db09 100644 --- a/vespajlib/src/main/java/com/yahoo/net/HostName.java +++ b/vespajlib/src/main/java/com/yahoo/net/HostName.java @@ -5,6 +5,9 @@ import java.util.Optional; /** * Utilities for getting the hostname of the system running the JVM. + * 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. * * @author arnej */ |