accumulo-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ktur...@apache.org
Subject [accumulo] 01/02: ACCUMULO-4170 Clarify ClientConfiguration javadocs
Date Fri, 13 Oct 2017 15:39:41 GMT
This is an automated email from the ASF dual-hosted git repository.

kturner pushed a commit to branch 1.8
in repository https://gitbox.apache.org/repos/asf/accumulo.git

commit e7d2bfa6ae926da88a57ca9d7a68c1971c91baae
Author: Mark Owens <jmarkowe@gmail.com>
AuthorDate: Fri Oct 13 11:25:26 2017 -0400

    ACCUMULO-4170 Clarify ClientConfiguration javadocs
    
    Updated the javadoc information for the loadDefaults() method.
    Specifically reworked the default search path information to be
    displayed as a list rather than inline, thereby easing readability.
    Reworded a few of the sentences.
    
    Closes #307
---
 .../accumulo/core/client/ClientConfiguration.java  | 22 +++++++++++++++-------
 1 file changed, 15 insertions(+), 7 deletions(-)

diff --git a/core/src/main/java/org/apache/accumulo/core/client/ClientConfiguration.java b/core/src/main/java/org/apache/accumulo/core/client/ClientConfiguration.java
index 1b9b380..0b15f53 100644
--- a/core/src/main/java/org/apache/accumulo/core/client/ClientConfiguration.java
+++ b/core/src/main/java/org/apache/accumulo/core/client/ClientConfiguration.java
@@ -199,13 +199,21 @@ public class ClientConfiguration extends CompositeConfiguration {
   }
 
   /**
-   * Attempts to load a configuration file from the system. Uses the "ACCUMULO_CLIENT_CONF_PATH"
environment variable, split on File.pathSeparator, for a list
-   * of target files. If not set, uses the following in this order- ~/.accumulo/config $ACCUMULO_CONF_DIR/client.conf
-OR- $ACCUMULO_HOME/conf/client.conf
-   * (depending on whether $ACCUMULO_CONF_DIR is set) /etc/accumulo/client.conf
-   *
-   * A client configuration will then be read from each location using PropertiesConfiguration
to construct a configuration. That means the latest item will be
-   * the one in the configuration.
-   *
+   * Attempts to load a configuration file from the system using the default search paths.
Uses the <em>ACCUMULO_CLIENT_CONF_PATH</em> environment variable,
+   * split on <em>File.pathSeparator</em>, for a list of target files.
+   * <p>
+   * If <em>ACCUMULO_CLIENT_CONF_PATH</em> is not set, uses the following in
this order:
+   * <ul>
+   * <li>~/.accumulo/config
+   * <li><em>$ACCUMULO_CONF_DIR</em>/client.conf, if <em>$ACCUMULO_CONF_DIR</em>
is defined.
+   * <li>/etc/accumulo/client.conf
+   * <li>/etc/accumulo/conf/client.conf
+   * </ul>
+   * <p>
+   * A client configuration will then be read from each location using <em>PropertiesConfiguration</em>
to construct a configuration. That means the latest item
+   * will be the one in the configuration.
+   * <p>
+   * 
    * @see PropertiesConfiguration
    * @see File#pathSeparator
    */

-- 
To stop receiving notification emails like this one, please contact
"commits@accumulo.apache.org" <commits@accumulo.apache.org>.

Mime
View raw message