[1/2] hadoop git commit: HADOOP-11559. Add links to RackAwareness and InterfaceClassification to site index (Masatake Iwasaki via aw)
Repository: hadoop Updated Branches: refs/heads/branch-2 7993fb5b8 -> 4ed7cf3b3 HADOOP-11559. Add links to RackAwareness and InterfaceClassification to site index (Masatake Iwasaki via aw) (cherry picked from commit 7eeca90daabd74934d4c94af6f07fd598abdb4ed) Conflicts: hadoop-common-project/hadoop-common/CHANGES.txt hadoop-project/src/site/site.xml Project: http://git-wip-us.apache.org/repos/asf/hadoop/repo Commit: http://git-wip-us.apache.org/repos/asf/hadoop/commit/fbdb23d2 Tree: http://git-wip-us.apache.org/repos/asf/hadoop/tree/fbdb23d2 Diff: http://git-wip-us.apache.org/repos/asf/hadoop/diff/fbdb23d2 Branch: refs/heads/branch-2 Commit: fbdb23d2afa993f96f073b9c4208282e8a280016 Parents: 7993fb5 Author: Allen WittenauerAuthored: Tue Feb 10 17:06:03 2015 -0800 Committer: Andrew Wang Committed: Mon Oct 17 13:32:28 2016 -0700 -- .../site/markdown/InterfaceClassification.md| 204 +++ .../src/site/markdown/RackAwareness.md | 54 - hadoop-project/src/site/site.xml| 2 +- 3 files changed, 204 insertions(+), 56 deletions(-) -- http://git-wip-us.apache.org/repos/asf/hadoop/blob/fbdb23d2/hadoop-common-project/hadoop-common/src/site/markdown/InterfaceClassification.md -- diff --git a/hadoop-common-project/hadoop-common/src/site/markdown/InterfaceClassification.md b/hadoop-common-project/hadoop-common/src/site/markdown/InterfaceClassification.md index 493b0dd..07abdac 100644 --- a/hadoop-common-project/hadoop-common/src/site/markdown/InterfaceClassification.md +++ b/hadoop-common-project/hadoop-common/src/site/markdown/InterfaceClassification.md @@ -20,80 +20,196 @@ Hadoop Interface Taxonomy: Audience and Stability Classification Motivation -- -The interface taxonomy classification provided here is for guidance to developers and users of interfaces. The classification guides a developer to declare the targeted audience or users of an interface and also its stability. +The interface taxonomy classification provided here is for guidance to +developers and users of interfaces. The classification guides a developer to +declare the targeted audience or users of an interface and also its stability. * Benefits to the user of an interface: Knows which interfaces to use or not use and their stability. -* Benefits to the developer: to prevent accidental changes of interfaces and hence accidental impact on users or other components or system. This is particularly useful in large systems with many developers who may not all have a shared state/history of the project. + +* Benefits to the developer: to prevent accidental changes of interfaces and + hence accidental impact on users or other components or system. This is + particularly useful in large systems with many developers who may not all have + a shared state/history of the project. Interface Classification -Hadoop adopts the following interface classification, this classification was derived from the [OpenSolaris taxonomy](http://www.opensolaris.org/os/community/arc/policies/interface-taxonomy/#Advice) and, to some extent, from taxonomy used inside Yahoo. Interfaces have two main attributes: Audience and Stability +Hadoop adopts the following interface classification, +this classification was derived from the +[OpenSolaris taxonomy](http://www.opensolaris.org/os/community/arc/policies/interface-taxonomy/#Advice) +and, to some extent, from taxonomy used inside Yahoo. +Interfaces have two main attributes: Audience and Stability ### Audience -Audience denotes the potential consumers of the interface. While many interfaces are internal/private to the implementation, other are public/external interfaces are meant for wider consumption by applications and/or clients. For example, in posix, libc is an external or public interface, while large parts of the kernel are internal or private interfaces. Also, some interfaces are targeted towards other specific subsystems. +Audience denotes the potential consumers of the interface. While many interfaces +are internal/private to the implementation, other are public/external interfaces +are meant for wider consumption by applications and/or clients. For example, in +posix, libc is an external or public interface, while large parts of the kernel +are internal or private interfaces. Also, some interfaces are targeted towards +other specific subsystems. -Identifying the audience of an interface helps define the impact of breaking it. For instance, it might be okay to break the compatibility of an interface whose audience is a small number of specific subsystems. On the other hand, it is probably not okay to break a protocol interfaces that
[1/2] hadoop git commit: HADOOP-11559. Add links to RackAwareness and InterfaceClassification to site index (Masatake Iwasaki via aw)
Repository: hadoop Updated Branches: refs/heads/branch-2.8 b2667441e -> 15ff590c3 HADOOP-11559. Add links to RackAwareness and InterfaceClassification to site index (Masatake Iwasaki via aw) (cherry picked from commit 7eeca90daabd74934d4c94af6f07fd598abdb4ed) Conflicts: hadoop-common-project/hadoop-common/CHANGES.txt hadoop-project/src/site/site.xml (cherry picked from commit fbdb23d2afa993f96f073b9c4208282e8a280016) Project: http://git-wip-us.apache.org/repos/asf/hadoop/repo Commit: http://git-wip-us.apache.org/repos/asf/hadoop/commit/9d473b8d Tree: http://git-wip-us.apache.org/repos/asf/hadoop/tree/9d473b8d Diff: http://git-wip-us.apache.org/repos/asf/hadoop/diff/9d473b8d Branch: refs/heads/branch-2.8 Commit: 9d473b8ddcea659cf362fa0f9331b10b9b4dfb7d Parents: b266744 Author: Allen WittenauerAuthored: Tue Feb 10 17:06:03 2015 -0800 Committer: Andrew Wang Committed: Mon Oct 17 13:32:51 2016 -0700 -- .../site/markdown/InterfaceClassification.md| 204 +++ .../src/site/markdown/RackAwareness.md | 54 - hadoop-project/src/site/site.xml| 2 +- 3 files changed, 204 insertions(+), 56 deletions(-) -- http://git-wip-us.apache.org/repos/asf/hadoop/blob/9d473b8d/hadoop-common-project/hadoop-common/src/site/markdown/InterfaceClassification.md -- diff --git a/hadoop-common-project/hadoop-common/src/site/markdown/InterfaceClassification.md b/hadoop-common-project/hadoop-common/src/site/markdown/InterfaceClassification.md index 493b0dd..07abdac 100644 --- a/hadoop-common-project/hadoop-common/src/site/markdown/InterfaceClassification.md +++ b/hadoop-common-project/hadoop-common/src/site/markdown/InterfaceClassification.md @@ -20,80 +20,196 @@ Hadoop Interface Taxonomy: Audience and Stability Classification Motivation -- -The interface taxonomy classification provided here is for guidance to developers and users of interfaces. The classification guides a developer to declare the targeted audience or users of an interface and also its stability. +The interface taxonomy classification provided here is for guidance to +developers and users of interfaces. The classification guides a developer to +declare the targeted audience or users of an interface and also its stability. * Benefits to the user of an interface: Knows which interfaces to use or not use and their stability. -* Benefits to the developer: to prevent accidental changes of interfaces and hence accidental impact on users or other components or system. This is particularly useful in large systems with many developers who may not all have a shared state/history of the project. + +* Benefits to the developer: to prevent accidental changes of interfaces and + hence accidental impact on users or other components or system. This is + particularly useful in large systems with many developers who may not all have + a shared state/history of the project. Interface Classification -Hadoop adopts the following interface classification, this classification was derived from the [OpenSolaris taxonomy](http://www.opensolaris.org/os/community/arc/policies/interface-taxonomy/#Advice) and, to some extent, from taxonomy used inside Yahoo. Interfaces have two main attributes: Audience and Stability +Hadoop adopts the following interface classification, +this classification was derived from the +[OpenSolaris taxonomy](http://www.opensolaris.org/os/community/arc/policies/interface-taxonomy/#Advice) +and, to some extent, from taxonomy used inside Yahoo. +Interfaces have two main attributes: Audience and Stability ### Audience -Audience denotes the potential consumers of the interface. While many interfaces are internal/private to the implementation, other are public/external interfaces are meant for wider consumption by applications and/or clients. For example, in posix, libc is an external or public interface, while large parts of the kernel are internal or private interfaces. Also, some interfaces are targeted towards other specific subsystems. +Audience denotes the potential consumers of the interface. While many interfaces +are internal/private to the implementation, other are public/external interfaces +are meant for wider consumption by applications and/or clients. For example, in +posix, libc is an external or public interface, while large parts of the kernel +are internal or private interfaces. Also, some interfaces are targeted towards +other specific subsystems. -Identifying the audience of an interface helps define the impact of breaking it. For instance, it might be okay to break the compatibility of an interface whose audience is a small number of specific subsystems. On the