Mailing-List: contact common-issues-help@hadoop.apache.org; run by ezmlm
Precedence: bulk
Date: Fri, 12 Aug 2016 14:30:20 +0000 (UTC)
From: "Karthik Kambatla (JIRA)" <jira@apache.org>
To: common-issues@hadoop.apache.org
Message-ID: <JIRA.12996769.1470952202000.292441.1471012220575@Atlassian.JIRA>
In-Reply-To: <JIRA.12996769.1470952202000@Atlassian.JIRA>
References: <JIRA.12996769.1470952202000@Atlassian.JIRA> <JIRA.12996769.1470952202823@arcas>
Subject: [jira] [Moved] (HADOOP-13493) Compatibility Docs should clarify the
 policy for what takes precedence when a conflict is found
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: quoted-printable
archived-at: Fri, 12 Aug 2016 14:30:22 -0000


     [ https://issues.apache.org/jira/browse/HADOOP-13493?page=3Dcom.atlass=
ian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Karthik Kambatla moved YARN-5515 to HADOOP-13493:
-------------------------------------------------

    Affects Version/s:     (was: 2.7.2)
                       2.7.2
          Component/s:     (was: documentation)
                       documentation
                  Key: HADOOP-13493  (was: YARN-5515)
              Project: Hadoop Common  (was: Hadoop YARN)

> Compatibility Docs should clarify the policy for what takes precedence wh=
en 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
>
> The Compatibility Docs (https://hadoop.apache.org/docs/r2.7.1/hadoop-proj=
ect-dist/hadoop-common/Compatibility.html#Java_API) list the policies for P=
rivate, 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 preced=
ence.
> As an example, until YARN-3225=C2=A0made it consistent, {{RefreshNodesReq=
uest}} looked like this:
> {code:java}
> @Private
> @Stable
> public abstract class RefreshNodesRequest {
>   @Public
>   @Stable
>   public static RefreshNodesRequest newInstance() {
>     RefreshNodesRequest request =3D 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.3.4#6332)

---------------------------------------------------------------------
To unsubscribe, e-mail: common-issues-unsubscribe@hadoop.apache.org
For additional commands, e-mail: common-issues-help@hadoop.apache.org