[
https://issues.apache.org/jira/browse/HADOOP-13493?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16272846#comment-16272846
]
Hudson commented on HADOOP-13493:
---------------------------------
SUCCESS: Integrated in Jenkins build Hadoop-trunk-Commit #13296 (See
[https://builds.apache.org/job/Hadoop-trunk-Commit/13296/])
HADOOP-13493. Compatibility Docs should clarify the policy for what (rkanter:
rev 75a3ab88f5f4ea6abf0a56cb8058e17b5a5fe403)
* (edit) hadoop-common-project/hadoop-common/src/site/markdown/Compatibility.md
> Compatibility Docs should clarify the policy for what takes precedence when a
> conflict is found
> -----------------------------------------------------------------------------------------------
>
> Key: HADOOP-13493
> URL: https://issues.apache.org/jira/browse/HADOOP-13493
> Project: Hadoop Common
> Issue Type: Task
> Components: documentation
> Affects Versions: 2.7.2
> Reporter: Robert Kanter
> Assignee: Daniel Templeton
> Priority: Critical
> Fix For: 3.0.0
>
> Attachments: HADOOP-13493.001.patch, HADOOP-13493.002.patch
>
>
> The Compatibility Docs
> (https://hadoop.apache.org/docs/r2.7.1/hadoop-project-dist/hadoop-common/Compatibility.html#Java_API)
> list the policies for Private, Public, not annotated, etc Classes and
> members, but it doesn't say what happens when there's a conflict. We should
> try obviously try to avoid this situation, but it would be good to explicitly
> state what takes precedence.
> As an example, until YARN-3225 made it consistent, {{RefreshNodesRequest}}
> looked like this:
> {code:java}
> @Private
> @Stable
> public abstract class RefreshNodesRequest {
> @Public
> @Stable
> public static RefreshNodesRequest newInstance() {
> RefreshNodesRequest request =
> Records.newRecord(RefreshNodesRequest.class);
> return request;
> }
> }
> {code}
> Note that the class is marked {{\@Private}}, but the method is marked
> {{\@Public}}.
> In this example, I'd say that the class level should have priority.
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
