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, 05 May 2010 23:22:07 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

Here's another patch which addresses all of Arun's points (except the one below). I've also
gone through and explicitly used Public and Stable annotations for classes where they were
previously implicit, which is why the patch is now so large. I've also made the Parser classes
in the join packages Evolving (after offline discussion with Chris).

> src/java/org/apache/hadoop/mapred/JobEndNotifier.java
> -> public, maybe evolving since end-users use this directly

I think this is private since its methods are only invoked by internal classes. Job notification
is set up by users using JobConf.setJobEndNotificationURI(). There doesn't seem to be a similar
method on Job for the new API, so you would have to configure using the property directly.

> 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: Sub-task
>          Components: documentation
>            Reporter: Tom White
>            Assignee: Tom White
>            Priority: Blocker
>             Fix For: 0.21.0
>
>         Attachments: M1623-1.patch, MAPREDUCE-1623.patch, MAPREDUCE-1623.patch, MAPREDUCE-1623.patch,
MAPREDUCE-1623.patch, MAPREDUCE-1623.patch, MAPREDUCE-1623.patch, MAPREDUCE-1623.patch, 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