You are viewing a plain text version of this content. The canonical link for it is here.
Posted to common-commits@hadoop.apache.org by st...@apache.org on 2020/02/17 22:14:53 UTC

[hadoop] branch trunk updated: HADOOP-16759. FileSystem Javadocs to list what breaks on API changes

This is an automated email from the ASF dual-hosted git repository.

stevel pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/hadoop.git


The following commit(s) were added to refs/heads/trunk by this push:
     new a562942  HADOOP-16759. FileSystem Javadocs to list what breaks on API changes
a562942 is described below

commit a562942b05a29d29e4a4fe3df4f35e2a8e7d208d
Author: Steve Loughran <st...@cloudera.com>
AuthorDate: Mon Feb 17 22:14:39 2020 +0000

    HADOOP-16759. FileSystem Javadocs to list what breaks on API changes
    
    Followup to the main openFile().withStatus() patch.
    It turns out that this broke the hive builds, which
    was not well appreciated.
    
    This patch lists places to review in the hadoop codebase,
    and external projects where changes are likely to cause problems.
    
    Contributed by Steve Loughran
    
    Change-Id: Ifac815c65b74d083cd277764b780ac2b5b0f6b36
---
 .../main/java/org/apache/hadoop/fs/FileSystem.java    | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/FileSystem.java b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/FileSystem.java
index 5d34428..b2d744d 100644
--- a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/FileSystem.java
+++ b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/FileSystem.java
@@ -132,6 +132,25 @@ import static org.apache.hadoop.fs.impl.PathCapabilitiesSupport.validatePathCapa
  * New methods may be marked as Unstable or Evolving for their initial release,
  * as a warning that they are new and may change based on the
  * experience of use in applications.
+ * <b>Important note for developers</b>
+ *
+ * If you're making changes here to the public API or protected methods,
+ * you must review the following subclasses and make sure that
+ * they are filtering/passing through new methods as appropriate.
+ *
+ * {@link FilterFileSystem}: methods are passed through.
+ * {@link ChecksumFileSystem}: checksums are created and
+ * verified.
+ * {@code TestHarFileSystem} will need its {@code MustNotImplement}
+ * interface updated.
+ *
+ * There are some external places your changes will break things.
+ * Do co-ordinate changes here.
+ *
+ * HBase: HBoss
+ * Hive: HiveShim23
+ * {@code shims/0.23/src/main/java/org/apache/hadoop/hive/shims/Hadoop23Shims.java}
+ *
  *****************************************************************/
 @SuppressWarnings("DeprecatedIsStillUsed")
 @InterfaceAudience.Public


---------------------------------------------------------------------
To unsubscribe, e-mail: common-commits-unsubscribe@hadoop.apache.org
For additional commands, e-mail: common-commits-help@hadoop.apache.org