[jira] Updated: (MAPREDUCE-1623) Apply audience and stability annotations to classes in mapred package

["Tom White (JIRA)" <ji...@apache.org>]

     [ 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 a new patch which covers all the core packages in MapReduce. The details are in the patch, but the following table gives a summary:

||Package org.apache.hadoop.|| Visibility & Stability || Notes ||
|filecache|deprecated| |
|mapred|deprecated or private unstable (for implementation classes)| |
|mapred.lib|deprecated| |
|mapred.pipes|public stable| |
|mapred.tools|public stable| |
|mapreduce|public evolving| |
|mapreduce.filecache|deprecated/private| |
|mapreduce.jobhistory|private unstable| |
|mapreduce.protocol|private stable| |
|mapreduce.security|private unstable/public evolving| |
|mapreduce.security.token*|private unstable| |
|mapreduce.server.jobtracker|private unstable| |
|mapreduce.server.tasktracker|private unstable| |
|mapreduce.split|private unstable| |
|mapreduce.task*|private unstable| |
|mapreduce.tools|public stable| |
|mapreduce.util|private unstable|All the util classes are for the framework, so shouldn't be public|
|util|deprecated| |

With this patch, MAPREDUCE-1650, and MAPREDUCE-1625, the public Javadoc looks like this: http://people.apache.org/~tomwhite/MAPREDUCE-1623/api/







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