You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@accumulo.apache.org by GitBox <gi...@apache.org> on 2021/07/07 20:00:10 UTC
[GitHub] [accumulo] ctubbsii commented on a change in pull request #2190: Add since information to properties
ctubbsii commented on a change in pull request #2190:
URL: https://github.com/apache/accumulo/pull/2190#discussion_r665658539
##########
File path: core/src/main/java/org/apache/accumulo/core/conf/ConfigurationDocGen.java
##########
@@ -80,16 +80,28 @@ void prefixSection(Property prefix) {
+ prefix.getKey() + "*** | ");
doc.print(prefix.isExperimental() ? "**Experimental.** " : "");
doc.println(
- (depr ? "**Deprecated.** " : "") + strike(sanitize(prefix.getDescription()), depr) + " |");
+ (depr
+ ? "**Deprecated since " + prefix.deprecatedSince() + ".** "
+ + (prefix.isReplaced() ? "**Replaced by " + "<a href=\"#"
+ + prefix.replacedBy().getKey().replace(".", "_") + "prefix\">"
+ + prefix.replacedBy() + "" + "</a>.** " : "")
+ : "**Available since " + prefix.availableSince() + ".** ")
+ + strike(sanitize(prefix.getDescription()), depr) + " |");
Review comment:
This code looks good, but I think we want to show "Available since" regardless of if it's deprecated. The above logic will only show it if it is not deprecated.
Also, can you work in line breaks (`<br>`), so that "Available since", "Deprecated since", and "Replaced by" show up on separate lines, above the description?
##########
File path: core/src/main/java/org/apache/accumulo/core/conf/ConfigurationDocGen.java
##########
@@ -80,16 +80,28 @@ void prefixSection(Property prefix) {
+ prefix.getKey() + "*** | ");
doc.print(prefix.isExperimental() ? "**Experimental.** " : "");
doc.println(
- (depr ? "**Deprecated.** " : "") + strike(sanitize(prefix.getDescription()), depr) + " |");
+ (depr
+ ? "**Deprecated since " + prefix.deprecatedSince() + ".** "
+ + (prefix.isReplaced() ? "**Replaced by " + "<a href=\"#"
+ + prefix.replacedBy().getKey().replace(".", "_") + "prefix\">"
+ + prefix.replacedBy() + "" + "</a>.** " : "")
+ : "**Available since " + prefix.availableSince() + ".** ")
+ + strike(sanitize(prefix.getDescription()), depr) + " |");
}
void property(Property prop) {
boolean depr = prop.isDeprecated();
doc.print("| <a name=\"" + prop.getKey().replace(".", "_") + "\" class=\"prop\"></a> "
+ prop.getKey() + " | ");
doc.print(prop.isExperimental() ? "**Experimental.** " : "");
- doc.print(
- (depr ? "**Deprecated.** " : "") + strike(sanitize(prop.getDescription()), depr) + "<br>");
+ doc.print((depr
+ ? "**Deprecated since " + prop.deprecatedSince() + ".** "
+ + (prop.isReplaced()
+ ? "**Replaced by " + "<a href=\"#" + prop.replacedBy().getKey().replace(".", "_")
+ + "\">" + prop.replacedBy() + "" + "</a>.** "
+ : "")
+ : "**Available since " + prop.availableSince() + ".** ")
+ + strike(sanitize(prop.getDescription()), depr) + "<br>");
Review comment:
Same comment here as above for the prefix types.
##########
File path: core/src/main/java/org/apache/accumulo/core/conf/Property.java
##########
@@ -49,49 +49,56 @@
// across all nodes in an instance)
RPC_PREFIX("rpc.", null, PropertyType.PREFIX,
"Properties in this category related to the configuration of SSL keys for"
- + " RPC. See also instance.ssl.enabled"),
+ + " RPC. See also instance.ssl.enabled",
+ "1.6.0"),
RPC_SSL_KEYSTORE_PATH("rpc.javax.net.ssl.keyStore", "", PropertyType.PATH,
- "Path of the keystore file for the server's private SSL key"),
+ "Path of the keystore file for the server's private SSL key", "1.6.0"),
@Sensitive
RPC_SSL_KEYSTORE_PASSWORD("rpc.javax.net.ssl.keyStorePassword", "", PropertyType.STRING,
"Password used to encrypt the SSL private keystore. "
- + "Leave blank to use the Accumulo instance secret"),
+ + "Leave blank to use the Accumulo instance secret",
+ "1.6.0"),
RPC_SSL_KEYSTORE_TYPE("rpc.javax.net.ssl.keyStoreType", "jks", PropertyType.STRING,
- "Type of SSL keystore"),
+ "Type of SSL keystore", "1.6.0"),
RPC_SSL_TRUSTSTORE_PATH("rpc.javax.net.ssl.trustStore", "", PropertyType.PATH,
- "Path of the truststore file for the root cert"),
+ "Path of the truststore file for the root cert", "1.6.0"),
@Sensitive
RPC_SSL_TRUSTSTORE_PASSWORD("rpc.javax.net.ssl.trustStorePassword", "", PropertyType.STRING,
- "Password used to encrypt the SSL truststore. Leave blank to use no password"),
+ "Password used to encrypt the SSL truststore. Leave blank to use no password", "1.6.0"),
RPC_SSL_TRUSTSTORE_TYPE("rpc.javax.net.ssl.trustStoreType", "jks", PropertyType.STRING,
- "Type of SSL truststore"),
+ "Type of SSL truststore", "1.6.0"),
RPC_USE_JSSE("rpc.useJsse", "false", PropertyType.BOOLEAN,
"Use JSSE system properties to configure SSL rather than the " + RPC_PREFIX.getKey()
- + "javax.net.ssl.* Accumulo properties"),
+ + "javax.net.ssl.* Accumulo properties",
+ "1.6.0"),
RPC_SSL_CIPHER_SUITES("rpc.ssl.cipher.suites", "", PropertyType.STRING,
- "Comma separated list of cipher suites that can be used by accepted connections"),
+ "Comma separated list of cipher suites that can be used by accepted connections", "1.6.1"),
RPC_SSL_ENABLED_PROTOCOLS("rpc.ssl.server.enabled.protocols", "TLSv1.2", PropertyType.STRING,
- "Comma separated list of protocols that can be used to accept connections"),
+ "Comma separated list of protocols that can be used to accept connections", "1.6.2"),
RPC_SSL_CLIENT_PROTOCOL("rpc.ssl.client.protocol", "TLSv1.2", PropertyType.STRING,
"The protocol used to connect to a secure server, must be in the list of enabled protocols "
- + "on the server side (rpc.ssl.server.enabled.protocols)"),
+ + "on the server side (rpc.ssl.server.enabled.protocols)",
+ "1.6.2"),
/**
* @since 1.7.0
Review comment:
Feel free to get rid of them.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@accumulo.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org