Chris Douglas commented on HDFS-13099:

It's not my favorite pattern. That said, 1) it's a project convention, 2) it's 
a consistent way to handle deprecation, and 3) unit tests aid consistency with 
{{-default.xml}} config files. If this is purely for documentation then it 
could assign the fields in {{DFSConfigKeys}}/{{DFSRouterKeys}} (or whatever) 
using the fields scoped to each class. That said, IIRC javadoc reorders the 
fields, so its virtues as documentation are pretty limited unless your field 
names follow a schema.

I'm ambivalent. The documentation for RBF and the impl docs are probably the 
better references, so I'd be tempted to leave it as-is.

> RBF: Refactor RBF relevant settings
> -----------------------------------
>                 Key: HDFS-13099
>                 URL: https://issues.apache.org/jira/browse/HDFS-13099
>             Project: Hadoop HDFS
>          Issue Type: Sub-task
>          Components: documentation
>    Affects Versions: 3.0.0
>            Reporter: Yiqun Lin
>            Assignee: Yiqun Lin
>            Priority: Minor
> Currently the State Store Driver relevant settings only written in its 
> implement classes.
> {noformat}
> public class StateStoreZooKeeperImpl extends StateStoreSerializableImpl {
> ...
>   /** Configuration keys. */
>   public static final String FEDERATION_STORE_ZK_DRIVER_PREFIX =
>       DFSConfigKeys.FEDERATION_STORE_PREFIX + "driver.zk.";
>   public static final String FEDERATION_STORE_ZK_PARENT_PATH =
>       FEDERATION_STORE_ZK_DRIVER_PREFIX + "parent-path";
>   public static final String FEDERATION_STORE_ZK_PARENT_PATH_DEFAULT =
>       "/hdfs-federation";
> ..
> {noformat}
> Actually, they should be moved into class {{DFSConfigKeys}} and documented in 
> file {{hdfs-default.xml}}. This will help more users know these settings and 
> know how to use.

This message was sent by Atlassian JIRA

To unsubscribe, e-mail: hdfs-issues-unsubscr...@hadoop.apache.org
For additional commands, e-mail: hdfs-issues-h...@hadoop.apache.org

Reply via email to