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 Mon, 03 May 2010 20:00:00 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 the feedback. I've created a new patch that reflects these classifications. I've
also got a few questions and comments below.


Job has a public method that returns TaskCompletionEvents - so shouldn't this be public evolving?
Similarly for TaskReport. Also, note that MapContext and ReduceContext are already public
evolving (see MAPREDUCE-1012), so I have left them like that.


MultithreadedMapper and RegexMapper are also in this package. Are you saying these are not
stable - so mark as public evolving? This question goes for the other mapreduce.lib packages.


I think these should be public stable too:
FileAlreadyExistsException, InvalidFileTypeException, InvalidInputException, InvalidJobConfException,
JobContext, JobStatus, JobQueueInfo, KeyValueLineRecordReader, KeyValueTextInputFormat, MapFileOutputFormat,
MapReduceBase, OutputLogFilter, SkipBadRecords, TaskAttemptContext, TaskReport, Utils


I think MultipleOutputs should be public stable too.

> 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, 0.22.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
> 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.

View raw message