hadoop-mapreduce-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Tom White (JIRA)" <j...@apache.org>
Subject [jira] Updated: (MAPREDUCE-1623) Apply audience and stability annotations to classes in mapred package
Date Wed, 31 Mar 2010 17:27:27 GMT

     [ https://issues.apache.org/jira/browse/MAPREDUCE-1623?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]

Tom White updated MAPREDUCE-1623:
---------------------------------

    Attachment: MAPREDUCE-1623.patch

Thanks for reviewing the changes, Amareshwari.

> I think org.apache.hadoop.mapred.IsolationRunner is public. Shall we add an unstable
annotation for the same?

Added.

> Is org.apache.hadoop.mapred.SkipBadRecords private or public? We should add the appropriate
annotation.

I think this is a public API. I notice that it is not deprecated since there is no replacement
in the new API. Is this an oversight that needs addressing?

> I think org.apache.hadoop.mapred.TaskLogAppender is private. Shall we add a private annotation
for the same?

I wasn't sure about this one. I left it public since it is specified in log4j.properties,
so to that extent it is publicly exposed. I've added an Unstable annotation to indicate that
its name/interface may change. Does this sound reasonable?

> Shall we annotate org.apache.hadoop.mapred.Utils.java as private ?

I think these are intended to be public, no? OutputLogFilter is deprecated in favour of mapred.Utils.

I've also added licenses to the new files.

> Apply audience and stability annotations to classes in mapred package
> ---------------------------------------------------------------------
>
>                 Key: MAPREDUCE-1623
>                 URL: https://issues.apache.org/jira/browse/MAPREDUCE-1623
>             Project: Hadoop Map/Reduce
>          Issue Type: Improvement
>          Components: documentation
>            Reporter: Tom White
>            Assignee: Tom White
>         Attachments: MAPREDUCE-1623.patch, MAPREDUCE-1623.patch, MAPREDUCE-1623.patch
>
>
> There are lots of implementation classes in org.apache.hadoop.mapred which makes it difficult
to see the user-level MapReduce API classes in the Javadoc. (See http://hadoop.apache.org/common/docs/r0.20.2/api/org/apache/hadoop/mapred/package-summary.html
for example.) By marking these implementation classes with the InterfaceAudience.Private annotation
we can exclude them from user Javadoc (using HADOOP-6658).
> Later work will move the implementation classes into o.a.h.mapreduce.server and related
packages (see MAPREDUCE-561), but applying the annotations is a good first step. 

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


Mime
View raw message