Uploaded image for project: 'Hadoop HDFS'
  1. Hadoop HDFS
  2. HDFS-10387

DataTransferProtocol#writeBlock missing some javadocs

    Details

    • Type: Improvement
    • Status: Resolved
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 2.9.0, 3.0.0-alpha1
    • Component/s: datanode, hdfs
    • Labels:
      None

      Description

      DataTransferProtocol#writeBlock's javadocs has the following parameters missing:

            final DataChecksum requestedChecksum,
            final CachingStrategy cachingStrategy,
      

        Activity

        Hide
        yzhangal Yongjun Zhang added a comment -

        Thanks John for being willing to help on this one.

        Show
        yzhangal Yongjun Zhang added a comment - Thanks John for being willing to help on this one.
        Hide
        jzhuge John Zhuge added a comment -

        allowLazyPersist also misses javadoc.

        Show
        jzhuge John Zhuge added a comment - allowLazyPersist also misses javadoc.
        Hide
        jzhuge John Zhuge added a comment -

        Please review patch 001:

        • Add javadoc for parameter requestedChecksum, cachingStrategy, and allowLazyPersist of DataTransferProtocol#writeBlock
        Show
        jzhuge John Zhuge added a comment - Please review patch 001: Add javadoc for parameter requestedChecksum, cachingStrategy, and allowLazyPersist of DataTransferProtocol#writeBlock
        Hide
        liuml07 Mingliang Liu added a comment -

        Thanks for the patch. May I ask why allowLazyPersist is stated as hint to the DataNode that...? By "hint", it appears that DataNode is free to ignore it.

        Show
        liuml07 Mingliang Liu added a comment - Thanks for the patch. May I ask why allowLazyPersist is stated as hint to the DataNode that... ? By "hint", it appears that DataNode is free to ignore it.
        Hide
        hadoopqa Hadoop QA added a comment -
        -1 overall



        Vote Subsystem Runtime Comment
        0 reexec 0m 11s Docker mode activated.
        +1 @author 0m 0s The patch does not contain any @author tags.
        -1 test4tests 0m 0s The patch doesn't appear to include any new or modified tests. Please justify why no new tests are needed for this patch. Also please list what manual steps were performed to verify this patch.
        +1 mvninstall 6m 44s trunk passed
        +1 compile 0m 27s trunk passed with JDK v1.8.0_91
        +1 compile 0m 29s trunk passed with JDK v1.7.0_95
        +1 checkstyle 0m 15s trunk passed
        +1 mvnsite 0m 33s trunk passed
        +1 mvneclipse 0m 12s trunk passed
        +1 findbugs 1m 39s trunk passed
        +1 javadoc 0m 20s trunk passed with JDK v1.8.0_91
        +1 javadoc 0m 24s trunk passed with JDK v1.7.0_95
        +1 mvninstall 0m 31s the patch passed
        +1 compile 0m 24s the patch passed with JDK v1.8.0_91
        +1 javac 0m 24s the patch passed
        +1 compile 0m 26s the patch passed with JDK v1.7.0_95
        +1 javac 0m 26s the patch passed
        +1 checkstyle 0m 13s the patch passed
        +1 mvnsite 0m 31s the patch passed
        +1 mvneclipse 0m 10s the patch passed
        +1 whitespace 0m 0s Patch has no whitespace issues.
        +1 findbugs 1m 51s the patch passed
        +1 javadoc 0m 17s the patch passed with JDK v1.8.0_91
        +1 javadoc 0m 23s the patch passed with JDK v1.7.0_95
        +1 unit 0m 49s hadoop-hdfs-client in the patch passed with JDK v1.8.0_91.
        +1 unit 0m 54s hadoop-hdfs-client in the patch passed with JDK v1.7.0_95.
        +1 asflicense 0m 20s Patch does not generate ASF License warnings.
        20m 0s



        Subsystem Report/Notes
        Docker Image:yetus/hadoop:cf2ee45
        JIRA Patch URL https://issues.apache.org/jira/secure/attachment/12803293/HDFS-10387.001.patch
        JIRA Issue HDFS-10387
        Optional Tests asflicense compile javac javadoc mvninstall mvnsite unit findbugs checkstyle
        uname Linux 0df541d65d09 3.13.0-36-lowlatency #63-Ubuntu SMP PREEMPT Wed Sep 3 21:56:12 UTC 2014 x86_64 x86_64 x86_64 GNU/Linux
        Build tool maven
        Personality /testptch/hadoop/patchprocess/precommit/personality/provided.sh
        git revision trunk / f0252ad
        Default Java 1.7.0_95
        Multi-JDK versions /usr/lib/jvm/java-8-oracle:1.8.0_91 /usr/lib/jvm/java-7-openjdk-amd64:1.7.0_95
        findbugs v3.0.0
        JDK v1.7.0_95 Test Results https://builds.apache.org/job/PreCommit-HDFS-Build/15407/testReport/
        modules C: hadoop-hdfs-project/hadoop-hdfs-client U: hadoop-hdfs-project/hadoop-hdfs-client
        Console output https://builds.apache.org/job/PreCommit-HDFS-Build/15407/console
        Powered by Apache Yetus 0.2.0 http://yetus.apache.org

        This message was automatically generated.

        Show
        hadoopqa Hadoop QA added a comment - -1 overall Vote Subsystem Runtime Comment 0 reexec 0m 11s Docker mode activated. +1 @author 0m 0s The patch does not contain any @author tags. -1 test4tests 0m 0s The patch doesn't appear to include any new or modified tests. Please justify why no new tests are needed for this patch. Also please list what manual steps were performed to verify this patch. +1 mvninstall 6m 44s trunk passed +1 compile 0m 27s trunk passed with JDK v1.8.0_91 +1 compile 0m 29s trunk passed with JDK v1.7.0_95 +1 checkstyle 0m 15s trunk passed +1 mvnsite 0m 33s trunk passed +1 mvneclipse 0m 12s trunk passed +1 findbugs 1m 39s trunk passed +1 javadoc 0m 20s trunk passed with JDK v1.8.0_91 +1 javadoc 0m 24s trunk passed with JDK v1.7.0_95 +1 mvninstall 0m 31s the patch passed +1 compile 0m 24s the patch passed with JDK v1.8.0_91 +1 javac 0m 24s the patch passed +1 compile 0m 26s the patch passed with JDK v1.7.0_95 +1 javac 0m 26s the patch passed +1 checkstyle 0m 13s the patch passed +1 mvnsite 0m 31s the patch passed +1 mvneclipse 0m 10s the patch passed +1 whitespace 0m 0s Patch has no whitespace issues. +1 findbugs 1m 51s the patch passed +1 javadoc 0m 17s the patch passed with JDK v1.8.0_91 +1 javadoc 0m 23s the patch passed with JDK v1.7.0_95 +1 unit 0m 49s hadoop-hdfs-client in the patch passed with JDK v1.8.0_91. +1 unit 0m 54s hadoop-hdfs-client in the patch passed with JDK v1.7.0_95. +1 asflicense 0m 20s Patch does not generate ASF License warnings. 20m 0s Subsystem Report/Notes Docker Image:yetus/hadoop:cf2ee45 JIRA Patch URL https://issues.apache.org/jira/secure/attachment/12803293/HDFS-10387.001.patch JIRA Issue HDFS-10387 Optional Tests asflicense compile javac javadoc mvninstall mvnsite unit findbugs checkstyle uname Linux 0df541d65d09 3.13.0-36-lowlatency #63-Ubuntu SMP PREEMPT Wed Sep 3 21:56:12 UTC 2014 x86_64 x86_64 x86_64 GNU/Linux Build tool maven Personality /testptch/hadoop/patchprocess/precommit/personality/provided.sh git revision trunk / f0252ad Default Java 1.7.0_95 Multi-JDK versions /usr/lib/jvm/java-8-oracle:1.8.0_91 /usr/lib/jvm/java-7-openjdk-amd64:1.7.0_95 findbugs v3.0.0 JDK v1.7.0_95 Test Results https://builds.apache.org/job/PreCommit-HDFS-Build/15407/testReport/ modules C: hadoop-hdfs-project/hadoop-hdfs-client U: hadoop-hdfs-project/hadoop-hdfs-client Console output https://builds.apache.org/job/PreCommit-HDFS-Build/15407/console Powered by Apache Yetus 0.2.0 http://yetus.apache.org This message was automatically generated.
        Hide
        jzhuge John Zhuge added a comment -

        Mingliang Liu The DN is free to ignore it. Copy from protobuf comment in datatransfer.proto:

          /**
           * Hint to the DataNode that the block can be allocated on transient
           * storage i.e. memory and written to disk lazily. The DataNode is free
           * to ignore this hint.
           */
          optional bool allowLazyPersist = 13 [default = false];
        
        Show
        jzhuge John Zhuge added a comment - Mingliang Liu The DN is free to ignore it. Copy from protobuf comment in datatransfer.proto : /** * Hint to the DataNode that the block can be allocated on transient * storage i.e. memory and written to disk lazily. The DataNode is free * to ignore this hint. */ optional bool allowLazyPersist = 13 [default = false];
        Hide
        liuml07 Mingliang Liu added a comment -

        That makes sense to me. Thanks for the explanation, John Zhuge.

        Show
        liuml07 Mingliang Liu added a comment - That makes sense to me. Thanks for the explanation, John Zhuge .
        Hide
        eddyxu Lei (Eddy) Xu added a comment -

        +1. Thanks! Document fixes are always welcome, John Zhuge

        Committed to trunk and branch-2.

        Show
        eddyxu Lei (Eddy) Xu added a comment - +1. Thanks! Document fixes are always welcome, John Zhuge Committed to trunk and branch-2.
        Hide
        jzhuge John Zhuge added a comment -

        Thanks Lei (Eddy) Xu.

        Show
        jzhuge John Zhuge added a comment - Thanks Lei (Eddy) Xu .
        Hide
        hudson Hudson added a comment -

        SUCCESS: Integrated in Hadoop-trunk-Commit #10083 (See https://builds.apache.org/job/Hadoop-trunk-Commit/10083/)
        HDFS-10387. DataTransferProtocol#writeBlock missing some javadocs (John (lei: rev d5f5a6475b19a52bf54f97cd8843408265b888f0)

        • hadoop-hdfs-project/hadoop-hdfs-client/src/main/java/org/apache/hadoop/hdfs/protocol/datatransfer/DataTransferProtocol.java
        Show
        hudson Hudson added a comment - SUCCESS: Integrated in Hadoop-trunk-Commit #10083 (See https://builds.apache.org/job/Hadoop-trunk-Commit/10083/ ) HDFS-10387 . DataTransferProtocol#writeBlock missing some javadocs (John (lei: rev d5f5a6475b19a52bf54f97cd8843408265b888f0) hadoop-hdfs-project/hadoop-hdfs-client/src/main/java/org/apache/hadoop/hdfs/protocol/datatransfer/DataTransferProtocol.java

          People

          • Assignee:
            jzhuge John Zhuge
            Reporter:
            yzhangal Yongjun Zhang
          • Votes:
            0 Vote for this issue
            Watchers:
            5 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development