hadoop-mapreduce-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Arun C Murthy (JIRA)" <j...@apache.org>
Subject [jira] Updated: (MAPREDUCE-1623) Apply audience and stability annotations to classes in mapred package
Date Wed, 05 May 2010 08:10:05 GMT

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

Arun C Murthy updated MAPREDUCE-1623:
-------------------------------------

           Status: Open  (was: Patch Available)
    Fix Version/s:     (was: 0.22.0)

Thanks for the update Tom, this is getting close!

Some more comments:

{quote}
> src/java/org/apache/hadoop/mapreduce/TaskType.java
> -> Public? Stable?
It is public. Not sure about whether it is stable yet.
{quote}
I'd tend to lean towards making it Stable to ensure it's never broken, it probably deserves
that status given how central it is to the framework. Thoughts?
I don't see either 'audience' for this yet it the patch, maybe you missed it?

bq. Are MarkableIterator and MarkableIteratorInterface public user classes? The unit test
for them (TestValueIterReset) implies that the user instantiates a MarkableIterator.
+1, public

bq. I left all of the lib.db classes public evolving since they are used by various extensions
and users. Does this sound reasonable?
+1

{quote}
> src/java/org/apache/hadoop/mapreduce/Job.java
> -> public

Yes.

> src/java/org/apache/hadoop/mapreduce/JobCounter.java
> -> public

Yes.

> src/java/org/apache/hadoop/mapreduce/JobPriority.java
> -> public

Yes.
{quote}

Again, I don't see 'audience' as 'public', another human miss on your part? Or am I seeing
the wrong patch?

----

Comments on rest of the classes I missed in the first pass:

src/java/org/apache/hadoop/mapreduce/security/token/package-info.java
-> Unstable
src/java/org/apache/hadoop/mapreduce/security/token/delegation/package-info.java
-> Unstable
src/java/org/apache/hadoop/mapreduce/TaskTrackerInfo.java
-> Public, used in Cluster
src/java/org/apache/hadoop/mapreduce/util/package-info.java
-> Unstable
src/java/org/apache/hadoop/mapreduce/TaskCompletionEvent.java
-> Public, Job.getTaskCompletionEvent
src/java/org/apache/hadoop/mapred/JobInProgress.java
-> limited-private, for schedulers
src/java/org/apache/hadoop/mapred/Task.java
-> limited-private, for schedulers
src/java/org/apache/hadoop/mapred/JobEndNotifier.java
-> public, maybe evolving since end-users use this directly
src/java/org/apache/hadoop/mapred/LineRecordReader.java
-> limited-private (mr, pig)
src/java/org/apache/hadoop/mapred/JobProfile.java
-> Odd, I thought this was 'public' - but I can't find any uses for it. The FairScheduler
uses it, so 'limited-private' ?
src/java/org/apache/hadoop/mapred/TaskCompletionEvent.java
-> public, accessible via JobClient


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