dlmarion commented on code in PR #5868:
URL: https://github.com/apache/accumulo/pull/5868#discussion_r2333188808


##########
core/src/main/java/org/apache/accumulo/core/conf/Property.java:
##########
@@ -84,22 +87,23 @@ public enum Property {
       "Properties in this category related to the configuration of SSL keys 
for"
           + " RPC. See also `instance.ssl.enabled`.",
       "1.6.0"),
-  RPC_PROCESS_ADVERTISE_ADDRESS("rpc.advertise.addr", "", PropertyType.STRING,
-      "The address to use when registering this server in ZooKeeper. This 
could be an"
-          + " IP address or hostname and defaults to rpc.bind.addr property 
value. Port "
-          + "numbers, if not specified, will default to the port property for 
the specific server type.",
-      "2.1.4"),
-  RPC_PROCESS_BIND_ADDRESS("rpc.bind.addr", "", PropertyType.STRING,
-      "The local IP address to which this server should bind for sending and 
receiving network traffic. If not set then the process binds to all addresses.",
-      "2.1.4"),
+  RPC_PROCESS_ADVERTISE_ADDRESS("rpc.advertise.addr", "", PropertyType.STRING, 
"""
+      The address to use when registering this server in ZooKeeper. This could 
be an \
+      IP address or hostname and defaults to rpc.bind.addr property value. 
Port \
+      numbers, if not specified, will default to the port property for the 
specific server type.
+      """, "2.1.4"),

Review Comment:
   The generated markdown for this looks like:
   ```
   | <a name="rpc_advertise_addr" class="prop"></a> rpc.advertise.addr | 
**Available since:** 2.1.4<br>The address to use when registering this server 
in ZooKeeper. This could be an IP address or hostname and defaults to 
rpc.bind.addr property value. Port numbers, if not specified, will default to 
the port property for the specific server type.<br><br>**type:** STRING, **zk 
mutable:** no, **default value:** empty |
   ```



##########
core/src/main/java/org/apache/accumulo/core/conf/Property.java:
##########
@@ -54,25 +54,28 @@ public enum Property {
   COMPACTION_PREFIX("compaction.", null, PropertyType.PREFIX,
       "Both major and minor compaction properties can be included under this 
prefix.", "4.0.0"),
   COMPACTION_SERVICE_PREFIX(COMPACTION_PREFIX + "service.", null, 
PropertyType.PREFIX,
-      "This prefix should be used to define all properties for the compaction 
services."
-          + "See {% jlink -f 
org.apache.accumulo.core.spi.compaction.RatioBasedCompactionPlanner %}.\n"
-          + "A new external compaction service would be defined like the 
following:\n"
-          + "`compaction.service.newService.planner="
-          + 
"\"org.apache.accumulo.core.spi.compaction.RatioBasedCompactionPlanner\".`\n"
-          + "`compaction.service.newService.opts.groups=\""
-          + "[{\"group\": \"small\", \"maxSize\":\"32M\"},"
-          + "{ \"group\":\"medium\", 
\"maxSize\":\"512M\"},{\"group\":\"large\"}]`\n"
-          + "`compaction.service.newService.opts.maxOpen=50`.\n"
-          + "Additional options can be defined using the 
`compaction.service.<service>.opts.<option>` property.",
+      """
+          This prefix should be used to define all properties for the 
compaction services.
+          See {% jlink -f 
org.apache.accumulo.core.spi.compaction.RatioBasedCompactionPlanner %}.
+          A new external compaction service would be defined like the 
following:
+            
`compaction.service.newService.planner="org.apache.accumulo.core.spi.compaction.RatioBasedCompactionPlanner".`
+            `compaction.service.newService.opts.groups="
+              [{"group": "small", "maxSize": "32M"},
+               {"group": "medium", "maxSize": "512M"},
+               {"group": "large"}]`
+            `compaction.service.newService.opts.maxOpen=50`
+          Additional options can be defined using the 
`compaction.service.<service>.opts.<option>` property.
+          """,

Review Comment:
   The generated markdown for this looks like:
   ```
   | <a name="compaction_service_prefix" class="prop"></a> 
**compaction.service.*** | **Available since:** 4.0.0<br>This prefix should be 
used to define all properties for the compaction services.<br>See {% jlink -f 
org.apache.accumulo.core.spi.compaction.RatioBasedCompactionPlanner %}.<br>A 
new external compaction service would be defined like the following:<br>  
`compaction.service.newService.planner="org.apache.accumulo.core.spi.compaction.RatioBasedCompactionPlanner".`<br>
  `compaction.service.newService.opts.groups="<br>    [{"group": "small", 
"maxSize": "32M"},<br>     {"group": "medium", "maxSize": "512M"},<br>     
{"group": "large"}]`<br>  
`compaction.service.newService.opts.maxOpen=50`<br>Additional options can be 
defined using the `compaction.service.<service>.opts.<option>` property.<br> |
   
   ```



-- 
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: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to