You are viewing a plain text version of this content. The canonical link for it is here.
Posted to common-issues@hadoop.apache.org by "Suresh Srinivas (Created) (JIRA)" <ji...@apache.org> on 2012/02/11 21:46:59 UTC
[jira] [Created] (HADOOP-8059) Add javadoc to InterfaceAudience and
InterfaceStability
Add javadoc to InterfaceAudience and InterfaceStability
-------------------------------------------------------
Key: HADOOP-8059
URL: https://issues.apache.org/jira/browse/HADOOP-8059
Project: Hadoop Common
Issue Type: Improvement
Components: documentation
Affects Versions: 0.24.0
Reporter: Suresh Srinivas
Assignee: Suresh Srinivas
InterfaceAudience and InterfaceStability javadoc is incomplete. The details from HADOOP-5073.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Updated] (HADOOP-8059) Add javadoc to InterfaceAudience and
InterfaceStability
Posted by "Brandon Li (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HADOOP-8059?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Brandon Li updated HADOOP-8059:
-------------------------------
Attachment: HADOOP-8059.patch
> Add javadoc to InterfaceAudience and InterfaceStability
> -------------------------------------------------------
>
> Key: HADOOP-8059
> URL: https://issues.apache.org/jira/browse/HADOOP-8059
> Project: Hadoop Common
> Issue Type: Improvement
> Components: documentation
> Affects Versions: 0.24.0
> Reporter: Suresh Srinivas
> Assignee: Brandon Li
> Attachments: HADOOP-8059.patch
>
>
> InterfaceAudience and InterfaceStability javadoc is incomplete. The details from HADOOP-5073.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Updated] (HADOOP-8059) Add javadoc to InterfaceAudience and
InterfaceStability
Posted by "Brandon Li (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HADOOP-8059?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Brandon Li updated HADOOP-8059:
-------------------------------
Attachment: HADOOP-8059.patch
Thanks Suresh for the detailed comments. Updated patch.
> Add javadoc to InterfaceAudience and InterfaceStability
> -------------------------------------------------------
>
> Key: HADOOP-8059
> URL: https://issues.apache.org/jira/browse/HADOOP-8059
> Project: Hadoop Common
> Issue Type: Improvement
> Components: documentation
> Affects Versions: 0.24.0
> Reporter: Suresh Srinivas
> Assignee: Brandon Li
> Attachments: HADOOP-8059.patch, HADOOP-8059.patch
>
>
> InterfaceAudience and InterfaceStability javadoc is incomplete. The details from HADOOP-5073.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Updated] (HADOOP-8059) Add javadoc to InterfaceAudience and
InterfaceStability
Posted by "Suresh Srinivas (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HADOOP-8059?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Suresh Srinivas updated HADOOP-8059:
------------------------------------
Affects Version/s: (was: 0.24.0)
3.0.0
2.0.0-alpha
Status: Patch Available (was: Open)
> Add javadoc to InterfaceAudience and InterfaceStability
> -------------------------------------------------------
>
> Key: HADOOP-8059
> URL: https://issues.apache.org/jira/browse/HADOOP-8059
> Project: Hadoop Common
> Issue Type: Improvement
> Components: documentation
> Affects Versions: 2.0.0-alpha, 3.0.0
> Reporter: Suresh Srinivas
> Assignee: Brandon Li
> Attachments: HADOOP-8059.patch, HADOOP-8059.patch
>
>
> InterfaceAudience and InterfaceStability javadoc is incomplete. The details from HADOOP-5073.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Commented] (HADOOP-8059) Add javadoc to InterfaceAudience
and InterfaceStability
Posted by "Hudson (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HADOOP-8059?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13402513#comment-13402513 ]
Hudson commented on HADOOP-8059:
--------------------------------
Integrated in Hadoop-Hdfs-trunk-Commit #2466 (See [https://builds.apache.org/job/Hadoop-Hdfs-trunk-Commit/2466/])
HADOOP-8059. Add javadoc to InterfaceAudience and InterfaceStability. Contributed by Brandon Li. (Revision 1354684)
Result = SUCCESS
suresh : http://svn.apache.org/viewcvs.cgi/?root=Apache-SVN&view=rev&rev=1354684
Files :
* /hadoop/common/trunk/hadoop-common-project/hadoop-annotations/src/main/java/org/apache/hadoop/classification/InterfaceAudience.java
* /hadoop/common/trunk/hadoop-common-project/hadoop-annotations/src/main/java/org/apache/hadoop/classification/InterfaceStability.java
* /hadoop/common/trunk/hadoop-common-project/hadoop-common/CHANGES.txt
> Add javadoc to InterfaceAudience and InterfaceStability
> -------------------------------------------------------
>
> Key: HADOOP-8059
> URL: https://issues.apache.org/jira/browse/HADOOP-8059
> Project: Hadoop Common
> Issue Type: Improvement
> Components: documentation
> Affects Versions: 2.0.0-alpha, 3.0.0
> Reporter: Suresh Srinivas
> Assignee: Brandon Li
> Fix For: 3.0.0
>
> Attachments: HADOOP-8059.patch, HADOOP-8059.patch
>
>
> InterfaceAudience and InterfaceStability javadoc is incomplete. The details from HADOOP-5073.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Commented] (HADOOP-8059) Add javadoc to InterfaceAudience
and InterfaceStability
Posted by "Hadoop QA (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HADOOP-8059?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13402500#comment-13402500 ]
Hadoop QA commented on HADOOP-8059:
-----------------------------------
+1 overall. Here are the results of testing the latest attachment
http://issues.apache.org/jira/secure/attachment/12533683/HADOOP-8059.patch
against trunk revision .
+1 @author. The patch does not contain any @author tags.
+0 tests included. The patch appears to be a documentation patch that doesn't require tests.
+1 javac. The applied patch does not increase the total number of javac compiler warnings.
+1 javadoc. The javadoc tool did not generate any warning messages.
+1 eclipse:eclipse. The patch built with eclipse:eclipse.
+1 findbugs. The patch does not introduce any new Findbugs (version 1.3.9) warnings.
+1 release audit. The applied patch does not increase the total number of release audit warnings.
+1 core tests. The patch passed unit tests in hadoop-common-project/hadoop-annotations.
+1 contrib tests. The patch passed contrib unit tests.
Test results: https://builds.apache.org/job/PreCommit-HADOOP-Build/1145//testReport/
Console output: https://builds.apache.org/job/PreCommit-HADOOP-Build/1145//console
This message is automatically generated.
> Add javadoc to InterfaceAudience and InterfaceStability
> -------------------------------------------------------
>
> Key: HADOOP-8059
> URL: https://issues.apache.org/jira/browse/HADOOP-8059
> Project: Hadoop Common
> Issue Type: Improvement
> Components: documentation
> Affects Versions: 2.0.0-alpha, 3.0.0
> Reporter: Suresh Srinivas
> Assignee: Brandon Li
> Attachments: HADOOP-8059.patch, HADOOP-8059.patch
>
>
> InterfaceAudience and InterfaceStability javadoc is incomplete. The details from HADOOP-5073.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Updated] (HADOOP-8059) Add javadoc to InterfaceAudience and
InterfaceStability
Posted by "Brandon Li (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HADOOP-8059?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Brandon Li updated HADOOP-8059:
-------------------------------
Assignee: Brandon Li (was: Hari Mankude)
> Add javadoc to InterfaceAudience and InterfaceStability
> -------------------------------------------------------
>
> Key: HADOOP-8059
> URL: https://issues.apache.org/jira/browse/HADOOP-8059
> Project: Hadoop Common
> Issue Type: Improvement
> Components: documentation
> Affects Versions: 0.24.0
> Reporter: Suresh Srinivas
> Assignee: Brandon Li
>
> InterfaceAudience and InterfaceStability javadoc is incomplete. The details from HADOOP-5073.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Commented] (HADOOP-8059) Add javadoc to InterfaceAudience
and InterfaceStability
Posted by "Hudson (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HADOOP-8059?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13403025#comment-13403025 ]
Hudson commented on HADOOP-8059:
--------------------------------
Integrated in Hadoop-Hdfs-trunk #1090 (See [https://builds.apache.org/job/Hadoop-Hdfs-trunk/1090/])
HADOOP-8059. Add javadoc to InterfaceAudience and InterfaceStability. Contributed by Brandon Li. (Revision 1354684)
Result = FAILURE
suresh : http://svn.apache.org/viewcvs.cgi/?root=Apache-SVN&view=rev&rev=1354684
Files :
* /hadoop/common/trunk/hadoop-common-project/hadoop-annotations/src/main/java/org/apache/hadoop/classification/InterfaceAudience.java
* /hadoop/common/trunk/hadoop-common-project/hadoop-annotations/src/main/java/org/apache/hadoop/classification/InterfaceStability.java
* /hadoop/common/trunk/hadoop-common-project/hadoop-common/CHANGES.txt
> Add javadoc to InterfaceAudience and InterfaceStability
> -------------------------------------------------------
>
> Key: HADOOP-8059
> URL: https://issues.apache.org/jira/browse/HADOOP-8059
> Project: Hadoop Common
> Issue Type: Improvement
> Components: documentation
> Affects Versions: 2.0.0-alpha, 3.0.0
> Reporter: Suresh Srinivas
> Assignee: Brandon Li
> Fix For: 3.0.0
>
> Attachments: HADOOP-8059.patch, HADOOP-8059.patch
>
>
> InterfaceAudience and InterfaceStability javadoc is incomplete. The details from HADOOP-5073.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Commented] (HADOOP-8059) Add javadoc to InterfaceAudience
and InterfaceStability
Posted by "Hudson (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HADOOP-8059?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13403124#comment-13403124 ]
Hudson commented on HADOOP-8059:
--------------------------------
Integrated in Hadoop-Mapreduce-trunk #1123 (See [https://builds.apache.org/job/Hadoop-Mapreduce-trunk/1123/])
HADOOP-8059. Add javadoc to InterfaceAudience and InterfaceStability. Contributed by Brandon Li. (Revision 1354684)
Result = FAILURE
suresh : http://svn.apache.org/viewcvs.cgi/?root=Apache-SVN&view=rev&rev=1354684
Files :
* /hadoop/common/trunk/hadoop-common-project/hadoop-annotations/src/main/java/org/apache/hadoop/classification/InterfaceAudience.java
* /hadoop/common/trunk/hadoop-common-project/hadoop-annotations/src/main/java/org/apache/hadoop/classification/InterfaceStability.java
* /hadoop/common/trunk/hadoop-common-project/hadoop-common/CHANGES.txt
> Add javadoc to InterfaceAudience and InterfaceStability
> -------------------------------------------------------
>
> Key: HADOOP-8059
> URL: https://issues.apache.org/jira/browse/HADOOP-8059
> Project: Hadoop Common
> Issue Type: Improvement
> Components: documentation
> Affects Versions: 2.0.0-alpha, 3.0.0
> Reporter: Suresh Srinivas
> Assignee: Brandon Li
> Fix For: 3.0.0
>
> Attachments: HADOOP-8059.patch, HADOOP-8059.patch
>
>
> InterfaceAudience and InterfaceStability javadoc is incomplete. The details from HADOOP-5073.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Commented] (HADOOP-8059) Add javadoc to InterfaceAudience
and InterfaceStability
Posted by "Hudson (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HADOOP-8059?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13402514#comment-13402514 ]
Hudson commented on HADOOP-8059:
--------------------------------
Integrated in Hadoop-Common-trunk-Commit #2397 (See [https://builds.apache.org/job/Hadoop-Common-trunk-Commit/2397/])
HADOOP-8059. Add javadoc to InterfaceAudience and InterfaceStability. Contributed by Brandon Li. (Revision 1354684)
Result = SUCCESS
suresh : http://svn.apache.org/viewcvs.cgi/?root=Apache-SVN&view=rev&rev=1354684
Files :
* /hadoop/common/trunk/hadoop-common-project/hadoop-annotations/src/main/java/org/apache/hadoop/classification/InterfaceAudience.java
* /hadoop/common/trunk/hadoop-common-project/hadoop-annotations/src/main/java/org/apache/hadoop/classification/InterfaceStability.java
* /hadoop/common/trunk/hadoop-common-project/hadoop-common/CHANGES.txt
> Add javadoc to InterfaceAudience and InterfaceStability
> -------------------------------------------------------
>
> Key: HADOOP-8059
> URL: https://issues.apache.org/jira/browse/HADOOP-8059
> Project: Hadoop Common
> Issue Type: Improvement
> Components: documentation
> Affects Versions: 2.0.0-alpha, 3.0.0
> Reporter: Suresh Srinivas
> Assignee: Brandon Li
> Fix For: 3.0.0
>
> Attachments: HADOOP-8059.patch, HADOOP-8059.patch
>
>
> InterfaceAudience and InterfaceStability javadoc is incomplete. The details from HADOOP-5073.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Updated] (HADOOP-8059) Add javadoc to InterfaceAudience and
InterfaceStability
Posted by "Suresh Srinivas (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HADOOP-8059?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Suresh Srinivas updated HADOOP-8059:
------------------------------------
Resolution: Fixed
Fix Version/s: 3.0.0
Hadoop Flags: Reviewed
Status: Resolved (was: Patch Available)
+1 for the patch. I committed it. Thank you Brandon.
> Add javadoc to InterfaceAudience and InterfaceStability
> -------------------------------------------------------
>
> Key: HADOOP-8059
> URL: https://issues.apache.org/jira/browse/HADOOP-8059
> Project: Hadoop Common
> Issue Type: Improvement
> Components: documentation
> Affects Versions: 2.0.0-alpha, 3.0.0
> Reporter: Suresh Srinivas
> Assignee: Brandon Li
> Fix For: 3.0.0
>
> Attachments: HADOOP-8059.patch, HADOOP-8059.patch
>
>
> InterfaceAudience and InterfaceStability javadoc is incomplete. The details from HADOOP-5073.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Assigned] (HADOOP-8059) Add javadoc to InterfaceAudience
and InterfaceStability
Posted by "Hari Mankude (Assigned) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HADOOP-8059?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Hari Mankude reassigned HADOOP-8059:
------------------------------------
Assignee: Hari Mankude (was: Suresh Srinivas)
> Add javadoc to InterfaceAudience and InterfaceStability
> -------------------------------------------------------
>
> Key: HADOOP-8059
> URL: https://issues.apache.org/jira/browse/HADOOP-8059
> Project: Hadoop Common
> Issue Type: Improvement
> Components: documentation
> Affects Versions: 0.24.0
> Reporter: Suresh Srinivas
> Assignee: Hari Mankude
>
> InterfaceAudience and InterfaceStability javadoc is incomplete. The details from HADOOP-5073.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Commented] (HADOOP-8059) Add javadoc to InterfaceAudience
and InterfaceStability
Posted by "Suresh Srinivas (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HADOOP-8059?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13402358#comment-13402358 ]
Suresh Srinivas commented on HADOOP-8059:
-----------------------------------------
Brandon, I as thinking of capturing information along following lines:
We should add some of the following comments:
# InterfaceAudience
#* All public classes must have InterfaceAudience annotation. Public classes that are not marked with this annotation must be considered by default as InterfaceAudience#Private.
#* External applications must only use classes that are marked InterfaceAudience#Public. Avoid using non public classes as these classes could be removed or change in incompatible ways.
#* Internal projects must only use classes that are marked InterfaceAudience#LimitedPrivate or InterfaceAudience#Public.
#* Methods may have a different annotation that it is more restrictive compared to the audience classification of the class. Example: A class might be InterfaceAudience#Publice, but a method may be InterfaceAudience#LimtedPrivate
# Interface stability
#* All classes that are annotated with InterfaceAudience#Public or LimitedPrivate must have InterfaceStability annotation.
#* Classes that are InterfaceAudience#Private are to be considered unstable unless a different InterfaceStability annotation states otherwise.
#* Incompatible changes must not be made to classes marked as stable.
> Add javadoc to InterfaceAudience and InterfaceStability
> -------------------------------------------------------
>
> Key: HADOOP-8059
> URL: https://issues.apache.org/jira/browse/HADOOP-8059
> Project: Hadoop Common
> Issue Type: Improvement
> Components: documentation
> Affects Versions: 0.24.0
> Reporter: Suresh Srinivas
> Assignee: Brandon Li
> Attachments: HADOOP-8059.patch
>
>
> InterfaceAudience and InterfaceStability javadoc is incomplete. The details from HADOOP-5073.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Commented] (HADOOP-8059) Add javadoc to InterfaceAudience
and InterfaceStability
Posted by "Hudson (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HADOOP-8059?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13402521#comment-13402521 ]
Hudson commented on HADOOP-8059:
--------------------------------
Integrated in Hadoop-Mapreduce-trunk-Commit #2416 (See [https://builds.apache.org/job/Hadoop-Mapreduce-trunk-Commit/2416/])
HADOOP-8059. Add javadoc to InterfaceAudience and InterfaceStability. Contributed by Brandon Li. (Revision 1354684)
Result = ABORTED
suresh : http://svn.apache.org/viewcvs.cgi/?root=Apache-SVN&view=rev&rev=1354684
Files :
* /hadoop/common/trunk/hadoop-common-project/hadoop-annotations/src/main/java/org/apache/hadoop/classification/InterfaceAudience.java
* /hadoop/common/trunk/hadoop-common-project/hadoop-annotations/src/main/java/org/apache/hadoop/classification/InterfaceStability.java
* /hadoop/common/trunk/hadoop-common-project/hadoop-common/CHANGES.txt
> Add javadoc to InterfaceAudience and InterfaceStability
> -------------------------------------------------------
>
> Key: HADOOP-8059
> URL: https://issues.apache.org/jira/browse/HADOOP-8059
> Project: Hadoop Common
> Issue Type: Improvement
> Components: documentation
> Affects Versions: 2.0.0-alpha, 3.0.0
> Reporter: Suresh Srinivas
> Assignee: Brandon Li
> Fix For: 3.0.0
>
> Attachments: HADOOP-8059.patch, HADOOP-8059.patch
>
>
> InterfaceAudience and InterfaceStability javadoc is incomplete. The details from HADOOP-5073.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira