From mapreduce-issues-return-13273-apmail-hadoop-mapreduce-issues-archive=hadoop.apache.org@hadoop.apache.org Tue May 04 00:54:21 2010 Return-Path: Delivered-To: apmail-hadoop-mapreduce-issues-archive@minotaur.apache.org Received: (qmail 58393 invoked from network); 4 May 2010 00:54:21 -0000 Received: from unknown (HELO mail.apache.org) (140.211.11.3) by 140.211.11.9 with SMTP; 4 May 2010 00:54:21 -0000 Received: (qmail 44764 invoked by uid 500); 4 May 2010 00:54:21 -0000 Delivered-To: apmail-hadoop-mapreduce-issues-archive@hadoop.apache.org Received: (qmail 44728 invoked by uid 500); 4 May 2010 00:54:21 -0000 Mailing-List: contact mapreduce-issues-help@hadoop.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: mapreduce-issues@hadoop.apache.org Delivered-To: mailing list mapreduce-issues@hadoop.apache.org Received: (qmail 44720 invoked by uid 99); 4 May 2010 00:54:21 -0000 Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 04 May 2010 00:54:21 +0000 X-ASF-Spam-Status: No, hits=-1382.8 required=10.0 tests=ALL_TRUSTED,AWL X-Spam-Check-By: apache.org Received: from [140.211.11.22] (HELO thor.apache.org) (140.211.11.22) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 04 May 2010 00:54:19 +0000 Received: from thor (localhost [127.0.0.1]) by thor.apache.org (8.13.8+Sun/8.13.8) with ESMTP id o440rxjm004135 for ; Tue, 4 May 2010 00:53:59 GMT Message-ID: <11604280.27591272934439462.JavaMail.jira@thor> Date: Mon, 3 May 2010 20:53:59 -0400 (EDT) From: "Arun C Murthy (JIRA)" To: mapreduce-issues@hadoop.apache.org Subject: [jira] Commented: (MAPREDUCE-1623) Apply audience and stability annotations to classes in mapred package In-Reply-To: <1147384204.453251269405031306.JavaMail.jira@brutus.apache.org> MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 7bit X-JIRA-FingerPrint: 30527f35849b9dde25b450d4833f0394 [ https://issues.apache.org/jira/browse/MAPREDUCE-1623?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12863592#action_12863592 ] Arun C Murthy commented on MAPREDUCE-1623: ------------------------------------------ I've not yet gone through the o.a.h.mapreduce.security and o.a.h.mapred packages, I'll do that later tonight, but here are early comments for the rest: src/java/org/apache/hadoop/mapreduce/MRConfig.java -> Stable? src/java/org/apache/hadoop/mapreduce/TaskType.java -> Public? Stable? src/java/org/apache/hadoop/mapreduce/StatusReporter.java -> Stable or Evolving? src/java/org/apache/hadoop/mapreduce/JobSubmitter.java -> Unstable? src/java/org/apache/hadoop/mapreduce/split/package-info.java -> Unstable? src/java/org/apache/hadoop/mapreduce/JobStatus.java -> Public? src/java/org/apache/hadoop/mapreduce/protocol/package-info.java -> Stable? src/java/org/apache/hadoop/mapreduce/task/package-info.java -> Unstable? src/java/org/apache/hadoop/mapreduce/task/reduce/package-info.java -> Unstable? src/java/org/apache/hadoop/mapreduce/task/reduce/ShuffleHeader.java -> Stable? (I'd like to keep it so, at least, thoughts?) src/java/org/apache/hadoop/mapreduce/lib/input/LineRecordReader.java -> Stable? Limited-Private (Pig) ? src/java/org/apache/hadoop/mapreduce/lib/db/OracleDataDrivenDBRecordReader.java -> private for extension? src/java/org/apache/hadoop/mapreduce/lib/db/MySQLDataDrivenDBRecordReader.java -> public for extension? src/java/org/apache/hadoop/mapreduce/lib/db/DateSplitter.java -> private? src/java/org/apache/hadoop/mapreduce/lib/db/OracleDataDrivenDBInputFormat.java -> public? src/java/org/apache/hadoop/mapreduce/lib/db/BooleanSplitter.java -> private? src/java/org/apache/hadoop/mapreduce/lib/db/BigDecimalSplitter.java -> private? src/java/org/apache/hadoop/mapreduce/lib/db/DBRecordReader.java -> public? src/java/org/apache/hadoop/mapreduce/lib/db/DataDrivenDBRecordReader.java -> public? src/java/org/apache/hadoop/mapreduce/lib/db/TextSplitter.java -> private? src/java/org/apache/hadoop/mapreduce/lib/db/DBSplitter.java -> private? src/java/org/apache/hadoop/mapreduce/lib/db/DBConfiguration.java -> private? src/java/org/apache/hadoop/mapreduce/lib/db/DBInputFormat.java -> public? src/java/org/apache/hadoop/mapreduce/lib/db/DBOutputFormat.java -> public? src/java/org/apache/hadoop/mapreduce/lib/db/DBWritable.java -> private? src/java/org/apache/hadoop/mapreduce/lib/db/DataDrivenDBInputFormat.java -> public? src/java/org/apache/hadoop/mapreduce/lib/db/IntegerSplitter.java -> private? src/java/org/apache/hadoop/mapreduce/lib/db/OracleDateSplitter.java -> private? src/java/org/apache/hadoop/mapreduce/lib/db/FloatSplitter.java -> private? src/java/org/apache/hadoop/mapreduce/lib/db/MySQLDBRecordReader.java -> public? src/java/org/apache/hadoop/mapreduce/lib/db/OracleDBRecordReader.java -> public? src/java/org/apache/hadoop/mapreduce/lib/reduce/WrappedReducer.java -> public? src/java/org/apache/hadoop/mapreduce/lib/partition/BinaryPartitioner.java -> public? src/java/org/apache/hadoop/mapreduce/lib/map/WrappedMapper.java -> public? src/java/org/apache/hadoop/mapreduce/server/jobtracker/State.java -> public? src/java/org/apache/hadoop/mapreduce/server/jobtracker/JTConfig.java -> private? src/java/org/apache/hadoop/mapreduce/server/jobtracker/TaskTracker.java -> limited-private for Schedulers src/java/org/apache/hadoop/mapreduce/server/tasktracker/TTConfig.java -> private? src/java/org/apache/hadoop/mapreduce/MarkableIterator.java -> private? src/java/org/apache/hadoop/mapreduce/TaskCounter.java -> public? src/java/org/apache/hadoop/mapreduce/QueueAclsInfo.java -> private? src/java/org/apache/hadoop/mapreduce/ClusterMetrics.java -> public src/java/org/apache/hadoop/mapreduce/MarkableIteratorInterface.java -> private src/java/org/apache/hadoop/mapreduce/Job.java -> public src/java/org/apache/hadoop/mapreduce/JobCounter.java -> public src/java/org/apache/hadoop/mapreduce/JobPriority.java -> public src/java/org/apache/hadoop/mapreduce/jobhistory/package-info.java -> private src/java/org/apache/hadoop/mapreduce/Cluster.java -> public src/java/org/apache/hadoop/mapreduce/QueueState.java -> private > 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.