hadoop-common-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Sanjay Radia (JIRA)" <j...@apache.org>
Subject [jira] Commented: (HADOOP-6668) Apply audience and stability annotations to classes in common
Date Fri, 14 May 2010 00:53:44 GMT

    [ https://issues.apache.org/jira/browse/HADOOP-6668?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12867336#action_12867336

Sanjay Radia commented on HADOOP-6668:

Tom, I have finished going though your annotations on Suresh's HADOOP-6289 proposal. Here
are my comments on 
areas of disagreements that you highlighted. Looks like we are fairly close now:
*  ipc packge is LimitedPrivate, Evolving  - agreed, we can wait to make it stable.
* The classification classes Public, evolving - agreed
* Configuration related classes - I would have prefered to make only Configuration public
because I am not a big fan of Configured or Configurable - I can live with making all of them
public but I do feel we are exposing more than we need to.
* ContentSummary, FsServerDefaults Public, Evolving.  But all the writable methods are Private.
* PositionedReadable, Seekable and Syncable - there was an internal debate in my corridor
 on this - lets discuss this on the jira.
* security classes limited private evolving
* DF, DU used by HDFS and MR for checking localfs - hence limitedPrivate evolving
* FsShell - we are only exposing bin/hadoop fs; FsShell is an implementation of it. Hence
* Trash - private - the public cmds delete and expunge cmds expose the functionality
* BinaryComparable, RawComparator, WritableComparator - public, agreed
* MapFile and SequenceFile - public, agreed
* io.compress classes - public except for bzip2 and zlib which are private unstable- agreed
* MD5Hash - public, agreed.
* Metrics - see my detailed comment above
* The io.serializer classes are private but the class name is public since it can be specified
in config (use the same solution as proposed for metric plugins.
* DNSToSwitchMapping - public, agreed
* GenericOptionsParser, private but Tool, ToolRunner public.
* Progressable - public, agreed
* ReflectionUtils,  limited private.
* FTPException, S3Exception, S3FileSystemException, VersionMismatchException, MultipleIOException
- public, agreed
* BloomMapFile - public agreed
* DefaultStringifier, SetFile, WritableFactories, WritableFactory, WritableName, WritableUtils
* TFile - public, Evolving.
* io.retry classes are used in HDFS and MapReduce, - LimitedPrivate, Evolving, agreed
* IOUtils - public, agreed
* LogLevel CLI - public, agreed
* AbstractFileSystem.java - leave as is Public evolving

> Apply audience and stability annotations to classes in common
> -------------------------------------------------------------
>                 Key: HADOOP-6668
>                 URL: https://issues.apache.org/jira/browse/HADOOP-6668
>             Project: Hadoop Common
>          Issue Type: Sub-task
>          Components: documentation
>            Reporter: Tom White
>            Assignee: Tom White
>            Priority: Blocker
>             Fix For: 0.21.0
>         Attachments: common.interface-tw-annotated.txt, HADOOP-6668.patch, HADOOP-6668.patch,
HADOOP-6668.patch, HADOOP-6668.patch, HADOOP-6668.patch, HADOOP-6668.patch
> Mark private implementation classes with the InterfaceAudience.Private or InterfaceAudience.LimitedPrivate
annotation to exclude them from user Javadoc and JDiff.

This message is automatically generated by JIRA.
You can reply to this email to add a comment to the issue online.

View raw message