[ https://issues.apache.org/jira/browse/HADOOP-5073?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12746744#action_12746744 ]
Sanjay Radia commented on HADOOP-5073: -------------------------------------- Doug said: >The implication on documentation should be something like: > * Public/stable should be documented. > * Public/evolving should documented, but must be well-marked as evolving. > * Private, limited or otherwise, should not be included in public > documentation, but only in internal documents. Agreed, However private/stable and private/evolving also need to be document even though they are not visible in the public documentation, only in the developer documentation. Developers need to understand which private/internal interfaces are stable since their stability needs to be maintained across releases, For example the client protocols need to be stable even though they are private for wire compatibility. > Hadoop 1.0 Interface Classification - scope (visibility - public/private) and > stability > --------------------------------------------------------------------------------------- > > Key: HADOOP-5073 > URL: https://issues.apache.org/jira/browse/HADOOP-5073 > Project: Hadoop Common > Issue Type: Sub-task > Reporter: Sanjay Radia > Assignee: Sanjay Radia > Attachments: 5073_demo.png, HADOOP-5073.patch > > > This jira proposes an interface classification for hadoop interfaces. > The discussion was started in email alias core-...@hadoop.apache.org in Nov > 2008. -- This message is automatically generated by JIRA. - You can reply to this email to add a comment to the issue online.