[
https://issues.apache.org/jira/browse/HADOOP-14875?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16360218#comment-16360218
]
Wangda Tan commented on HADOOP-14875:
-------------------------------------
Thanks [~templedf], only a few minor comments:
1) REST APIs:
I suggest to restrict compatibility for "exposed APIs" mentioned in
https://hadoop.apache.org/docs/current/hadoop-project-dist/hadoop-common/Compatibility.html#REST_APIs
It is possible that some APIs are intended for internal uses only, thus we
don't expose them, I would not prefer to maintain compatibility for such APIs.
2) Metrics/JMX:
bq. The metrics format may not change in an incompatible way between major
releases, but new records and fields can be compatibly added at any time.
Only to add one thing: the text fields of metrics/JMX are intended primarily
for a human reader. For example, diagnostics.
We may need to add this to
https://hadoop.apache.org/docs/current/hadoop-project-dist/hadoop-common/Compatibility.html#REST_APIs
as well.
3) CLI:
For this doc and
https://hadoop.apache.org/docs/current/hadoop-project-dist/hadoop-common/Compatibility.html#REST_APIs:
it's better to add "unless documented, no CLI tool options will be removed or
change semantically". Because some options are experimental and subject to
change, developers will add a note to these options.
4)
bq. Even between minor releases incompatible configuration file format changes
will be avoided if possible.
I think it should be "major releases", correct?
> Create end user documentation from the compatibility guidelines
> ---------------------------------------------------------------
>
> Key: HADOOP-14875
> URL: https://issues.apache.org/jira/browse/HADOOP-14875
> Project: Hadoop Common
> Issue Type: Improvement
> Components: documentation
> Affects Versions: 3.0.0-beta1
> Reporter: Daniel Templeton
> Assignee: Daniel Templeton
> Priority: Critical
> Attachments: AdminCompatibilityGuide.pdf, Compatibility.htm,
> HADOOP-14875.001.patch, HADOOP-14875.002.patch, HADOOP-14875.003.patch
>
>
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
