Hadoop Common
  1. Hadoop Common
  2. HADOOP-7981

Improve documentation for org.apache.hadoop.io.compress.Decompressor.getRemaining

    Details

    • Type: Bug Bug
    • Status: Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: 0.23.1
    • Fix Version/s: 0.23.1
    • Component/s: io
    • Labels:
      None
    1. HADOOP-7981.patch
      3 kB
      Jonathan Eagles

      Activity

      Arun C Murthy made changes -
      Status Resolved [ 5 ] Closed [ 6 ]
      Hide
      Hudson added a comment -

      Integrated in Hadoop-Mapreduce-trunk #968 (See https://builds.apache.org/job/Hadoop-Mapreduce-trunk/968/)
      HADOOP-7981. Improve documentation for org.apache.hadoop.io.compress.Decompressor.getRemaining (Jonathan Eagles via mahadev)

      mahadev : http://svn.apache.org/viewcvs.cgi/?root=Apache-SVN&view=rev&rev=1235007
      Files :

      • /hadoop/common/trunk/hadoop-common-project/hadoop-common/CHANGES.txt
      • /hadoop/common/trunk/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/compress/Decompressor.java
      Show
      Hudson added a comment - Integrated in Hadoop-Mapreduce-trunk #968 (See https://builds.apache.org/job/Hadoop-Mapreduce-trunk/968/ ) HADOOP-7981 . Improve documentation for org.apache.hadoop.io.compress.Decompressor.getRemaining (Jonathan Eagles via mahadev) mahadev : http://svn.apache.org/viewcvs.cgi/?root=Apache-SVN&view=rev&rev=1235007 Files : /hadoop/common/trunk/hadoop-common-project/hadoop-common/CHANGES.txt /hadoop/common/trunk/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/compress/Decompressor.java
      Hide
      Hudson added a comment -

      Integrated in Hadoop-Mapreduce-0.23-Build #170 (See https://builds.apache.org/job/Hadoop-Mapreduce-0.23-Build/170/)
      HADOOP-7981. Improve documentation for org.apache.hadoop.io.compress. Decompressor.getRemaining (Jonathan Eagles via mahadev) - Merging r1235007 from trunk.

      mahadev : http://svn.apache.org/viewcvs.cgi/?root=Apache-SVN&view=rev&rev=1235010
      Files :

      • /hadoop/common/branches/branch-0.23/hadoop-common-project/hadoop-common/CHANGES.txt
      • /hadoop/common/branches/branch-0.23/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/compress/Decompressor.java
      Show
      Hudson added a comment - Integrated in Hadoop-Mapreduce-0.23-Build #170 (See https://builds.apache.org/job/Hadoop-Mapreduce-0.23-Build/170/ ) HADOOP-7981 . Improve documentation for org.apache.hadoop.io.compress. Decompressor.getRemaining (Jonathan Eagles via mahadev) - Merging r1235007 from trunk. mahadev : http://svn.apache.org/viewcvs.cgi/?root=Apache-SVN&view=rev&rev=1235010 Files : /hadoop/common/branches/branch-0.23/hadoop-common-project/hadoop-common/CHANGES.txt /hadoop/common/branches/branch-0.23/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/compress/Decompressor.java
      Hide
      Hudson added a comment -

      Integrated in Hadoop-Hdfs-0.23-Build #148 (See https://builds.apache.org/job/Hadoop-Hdfs-0.23-Build/148/)
      HADOOP-7981. Improve documentation for org.apache.hadoop.io.compress. Decompressor.getRemaining (Jonathan Eagles via mahadev) - Merging r1235007 from trunk.

      mahadev : http://svn.apache.org/viewcvs.cgi/?root=Apache-SVN&view=rev&rev=1235010
      Files :

      • /hadoop/common/branches/branch-0.23/hadoop-common-project/hadoop-common/CHANGES.txt
      • /hadoop/common/branches/branch-0.23/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/compress/Decompressor.java
      Show
      Hudson added a comment - Integrated in Hadoop-Hdfs-0.23-Build #148 (See https://builds.apache.org/job/Hadoop-Hdfs-0.23-Build/148/ ) HADOOP-7981 . Improve documentation for org.apache.hadoop.io.compress. Decompressor.getRemaining (Jonathan Eagles via mahadev) - Merging r1235007 from trunk. mahadev : http://svn.apache.org/viewcvs.cgi/?root=Apache-SVN&view=rev&rev=1235010 Files : /hadoop/common/branches/branch-0.23/hadoop-common-project/hadoop-common/CHANGES.txt /hadoop/common/branches/branch-0.23/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/compress/Decompressor.java
      Hide
      Hudson added a comment -

      Integrated in Hadoop-Hdfs-trunk #935 (See https://builds.apache.org/job/Hadoop-Hdfs-trunk/935/)
      HADOOP-7981. Improve documentation for org.apache.hadoop.io.compress.Decompressor.getRemaining (Jonathan Eagles via mahadev)

      mahadev : http://svn.apache.org/viewcvs.cgi/?root=Apache-SVN&view=rev&rev=1235007
      Files :

      • /hadoop/common/trunk/hadoop-common-project/hadoop-common/CHANGES.txt
      • /hadoop/common/trunk/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/compress/Decompressor.java
      Show
      Hudson added a comment - Integrated in Hadoop-Hdfs-trunk #935 (See https://builds.apache.org/job/Hadoop-Hdfs-trunk/935/ ) HADOOP-7981 . Improve documentation for org.apache.hadoop.io.compress.Decompressor.getRemaining (Jonathan Eagles via mahadev) mahadev : http://svn.apache.org/viewcvs.cgi/?root=Apache-SVN&view=rev&rev=1235007 Files : /hadoop/common/trunk/hadoop-common-project/hadoop-common/CHANGES.txt /hadoop/common/trunk/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/compress/Decompressor.java
      Hide
      Hudson added a comment -

      Integrated in Hadoop-Mapreduce-trunk-Commit #1590 (See https://builds.apache.org/job/Hadoop-Mapreduce-trunk-Commit/1590/)
      HADOOP-7981. Improve documentation for org.apache.hadoop.io.compress.Decompressor.getRemaining (Jonathan Eagles via mahadev)

      mahadev : http://svn.apache.org/viewcvs.cgi/?root=Apache-SVN&view=rev&rev=1235007
      Files :

      • /hadoop/common/trunk/hadoop-common-project/hadoop-common/CHANGES.txt
      • /hadoop/common/trunk/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/compress/Decompressor.java
      Show
      Hudson added a comment - Integrated in Hadoop-Mapreduce-trunk-Commit #1590 (See https://builds.apache.org/job/Hadoop-Mapreduce-trunk-Commit/1590/ ) HADOOP-7981 . Improve documentation for org.apache.hadoop.io.compress.Decompressor.getRemaining (Jonathan Eagles via mahadev) mahadev : http://svn.apache.org/viewcvs.cgi/?root=Apache-SVN&view=rev&rev=1235007 Files : /hadoop/common/trunk/hadoop-common-project/hadoop-common/CHANGES.txt /hadoop/common/trunk/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/compress/Decompressor.java
      Hide
      Jonathan Eagles added a comment -

      Great catch, Mahadev! It's amazing how easy it is to pass over a spelling error.

      Show
      Jonathan Eagles added a comment - Great catch, Mahadev! It's amazing how easy it is to pass over a spelling error.
      Hide
      Hudson added a comment -

      Integrated in Hadoop-Mapreduce-0.23-Commit #421 (See https://builds.apache.org/job/Hadoop-Mapreduce-0.23-Commit/421/)
      HADOOP-7981. Improve documentation for org.apache.hadoop.io.compress. Decompressor.getRemaining (Jonathan Eagles via mahadev) - Merging r1235007 from trunk.

      mahadev : http://svn.apache.org/viewcvs.cgi/?root=Apache-SVN&view=rev&rev=1235010
      Files :

      • /hadoop/common/branches/branch-0.23/hadoop-common-project/hadoop-common/CHANGES.txt
      • /hadoop/common/branches/branch-0.23/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/compress/Decompressor.java
      Show
      Hudson added a comment - Integrated in Hadoop-Mapreduce-0.23-Commit #421 (See https://builds.apache.org/job/Hadoop-Mapreduce-0.23-Commit/421/ ) HADOOP-7981 . Improve documentation for org.apache.hadoop.io.compress. Decompressor.getRemaining (Jonathan Eagles via mahadev) - Merging r1235007 from trunk. mahadev : http://svn.apache.org/viewcvs.cgi/?root=Apache-SVN&view=rev&rev=1235010 Files : /hadoop/common/branches/branch-0.23/hadoop-common-project/hadoop-common/CHANGES.txt /hadoop/common/branches/branch-0.23/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/compress/Decompressor.java
      Hide
      Hudson added a comment -

      Integrated in Hadoop-Hdfs-trunk-Commit #1645 (See https://builds.apache.org/job/Hadoop-Hdfs-trunk-Commit/1645/)
      HADOOP-7981. Improve documentation for org.apache.hadoop.io.compress.Decompressor.getRemaining (Jonathan Eagles via mahadev)

      mahadev : http://svn.apache.org/viewcvs.cgi/?root=Apache-SVN&view=rev&rev=1235007
      Files :

      • /hadoop/common/trunk/hadoop-common-project/hadoop-common/CHANGES.txt
      • /hadoop/common/trunk/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/compress/Decompressor.java
      Show
      Hudson added a comment - Integrated in Hadoop-Hdfs-trunk-Commit #1645 (See https://builds.apache.org/job/Hadoop-Hdfs-trunk-Commit/1645/ ) HADOOP-7981 . Improve documentation for org.apache.hadoop.io.compress.Decompressor.getRemaining (Jonathan Eagles via mahadev) mahadev : http://svn.apache.org/viewcvs.cgi/?root=Apache-SVN&view=rev&rev=1235007 Files : /hadoop/common/trunk/hadoop-common-project/hadoop-common/CHANGES.txt /hadoop/common/trunk/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/compress/Decompressor.java
      Hide
      Hudson added a comment -

      Integrated in Hadoop-Hdfs-0.23-Commit #396 (See https://builds.apache.org/job/Hadoop-Hdfs-0.23-Commit/396/)
      HADOOP-7981. Improve documentation for org.apache.hadoop.io.compress. Decompressor.getRemaining (Jonathan Eagles via mahadev) - Merging r1235007 from trunk.

      mahadev : http://svn.apache.org/viewcvs.cgi/?root=Apache-SVN&view=rev&rev=1235010
      Files :

      • /hadoop/common/branches/branch-0.23/hadoop-common-project/hadoop-common/CHANGES.txt
      • /hadoop/common/branches/branch-0.23/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/compress/Decompressor.java
      Show
      Hudson added a comment - Integrated in Hadoop-Hdfs-0.23-Commit #396 (See https://builds.apache.org/job/Hadoop-Hdfs-0.23-Commit/396/ ) HADOOP-7981 . Improve documentation for org.apache.hadoop.io.compress. Decompressor.getRemaining (Jonathan Eagles via mahadev) - Merging r1235007 from trunk. mahadev : http://svn.apache.org/viewcvs.cgi/?root=Apache-SVN&view=rev&rev=1235010 Files : /hadoop/common/branches/branch-0.23/hadoop-common-project/hadoop-common/CHANGES.txt /hadoop/common/branches/branch-0.23/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/compress/Decompressor.java
      Hide
      Hudson added a comment -

      Integrated in Hadoop-Common-trunk-Commit #1572 (See https://builds.apache.org/job/Hadoop-Common-trunk-Commit/1572/)
      HADOOP-7981. Improve documentation for org.apache.hadoop.io.compress.Decompressor.getRemaining (Jonathan Eagles via mahadev)

      mahadev : http://svn.apache.org/viewcvs.cgi/?root=Apache-SVN&view=rev&rev=1235007
      Files :

      • /hadoop/common/trunk/hadoop-common-project/hadoop-common/CHANGES.txt
      • /hadoop/common/trunk/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/compress/Decompressor.java
      Show
      Hudson added a comment - Integrated in Hadoop-Common-trunk-Commit #1572 (See https://builds.apache.org/job/Hadoop-Common-trunk-Commit/1572/ ) HADOOP-7981 . Improve documentation for org.apache.hadoop.io.compress.Decompressor.getRemaining (Jonathan Eagles via mahadev) mahadev : http://svn.apache.org/viewcvs.cgi/?root=Apache-SVN&view=rev&rev=1235007 Files : /hadoop/common/trunk/hadoop-common-project/hadoop-common/CHANGES.txt /hadoop/common/trunk/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/compress/Decompressor.java
      Hide
      Hudson added a comment -

      Integrated in Hadoop-Common-0.23-Commit #406 (See https://builds.apache.org/job/Hadoop-Common-0.23-Commit/406/)
      HADOOP-7981. Improve documentation for org.apache.hadoop.io.compress. Decompressor.getRemaining (Jonathan Eagles via mahadev) - Merging r1235007 from trunk.

      mahadev : http://svn.apache.org/viewcvs.cgi/?root=Apache-SVN&view=rev&rev=1235010
      Files :

      • /hadoop/common/branches/branch-0.23/hadoop-common-project/hadoop-common/CHANGES.txt
      • /hadoop/common/branches/branch-0.23/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/compress/Decompressor.java
      Show
      Hudson added a comment - Integrated in Hadoop-Common-0.23-Commit #406 (See https://builds.apache.org/job/Hadoop-Common-0.23-Commit/406/ ) HADOOP-7981 . Improve documentation for org.apache.hadoop.io.compress. Decompressor.getRemaining (Jonathan Eagles via mahadev) - Merging r1235007 from trunk. mahadev : http://svn.apache.org/viewcvs.cgi/?root=Apache-SVN&view=rev&rev=1235010 Files : /hadoop/common/branches/branch-0.23/hadoop-common-project/hadoop-common/CHANGES.txt /hadoop/common/branches/branch-0.23/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/compress/Decompressor.java
      Mahadev konar made changes -
      Status Patch Available [ 10002 ] Resolved [ 5 ]
      Fix Version/s 0.23.1 [ 12318884 ]
      Resolution Fixed [ 1 ]
      Hide
      Mahadev konar added a comment -

      I just committed this. Thanks Jon!

      Show
      Mahadev konar added a comment - I just committed this. Thanks Jon!
      Hide
      Mahadev konar added a comment -

      +1 the patch looks good.

      One minor nit. "positiive" -> "positive. Will just make the change when committing.

      Show
      Mahadev konar added a comment - +1 the patch looks good. One minor nit. "positiive" -> "positive. Will just make the change when committing.
      Hide
      Jonathan Eagles added a comment -

      7 Javadoc warnings are present in trunk.
      No tests are needed for this documentation change.

      Show
      Jonathan Eagles added a comment - 7 Javadoc warnings are present in trunk. No tests are needed for this documentation change.
      Jonathan Eagles made changes -
      Status Open [ 1 ] Patch Available [ 10002 ]
      Jonathan Eagles made changes -
      Status Patch Available [ 10002 ] Open [ 1 ]
      Hide
      Hadoop QA added a comment -

      -1 overall. Here are the results of testing the latest attachment
      http://issues.apache.org/jira/secure/attachment/12511194/HADOOP-7981.patch
      against trunk revision .

      +1 @author. The patch does not contain any @author tags.

      -1 tests included. 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 javadoc. The javadoc tool appears to have generated 7 warning messages.

      +1 javac. The applied patch does not increase the total number of javac compiler warnings.

      +1 eclipse:eclipse. The patch built with eclipse:eclipse.

      +1 findbugs. The patch does not introduce any new Findbugs (version 1.3.9) warnings.

      +1 release audit. The applied patch does not increase the total number of release audit warnings.

      +1 core tests. The patch passed unit tests in .

      +1 contrib tests. The patch passed contrib unit tests.

      Test results: https://builds.apache.org/job/PreCommit-HADOOP-Build/519//testReport/
      Console output: https://builds.apache.org/job/PreCommit-HADOOP-Build/519//console

      This message is automatically generated.

      Show
      Hadoop QA added a comment - -1 overall. Here are the results of testing the latest attachment http://issues.apache.org/jira/secure/attachment/12511194/HADOOP-7981.patch against trunk revision . +1 @author. The patch does not contain any @author tags. -1 tests included. 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 javadoc. The javadoc tool appears to have generated 7 warning messages. +1 javac. The applied patch does not increase the total number of javac compiler warnings. +1 eclipse:eclipse. The patch built with eclipse:eclipse. +1 findbugs. The patch does not introduce any new Findbugs (version 1.3.9) warnings. +1 release audit. The applied patch does not increase the total number of release audit warnings. +1 core tests. The patch passed unit tests in . +1 contrib tests. The patch passed contrib unit tests. Test results: https://builds.apache.org/job/PreCommit-HADOOP-Build/519//testReport/ Console output: https://builds.apache.org/job/PreCommit-HADOOP-Build/519//console This message is automatically generated.
      Hide
      Jonathan Eagles added a comment -

      First round of documentation changes.

      Show
      Jonathan Eagles added a comment - First round of documentation changes.
      Jonathan Eagles made changes -
      Status Open [ 1 ] Patch Available [ 10002 ]
      Jonathan Eagles made changes -
      Attachment HADOOP-7981.patch [ 12511194 ]
      Jonathan Eagles made changes -
      Field Original Value New Value
      Assignee Jonathan Eagles [ jeagles ]
      Hide
      Jonathan Eagles added a comment -

      Make clear when this API will be caused from the system.
      Make clear what actions the system will take based on the return value
      Make clear distinction between getRemaining == 0 and isFinished == true

      Show
      Jonathan Eagles added a comment - Make clear when this API will be caused from the system. Make clear what actions the system will take based on the return value Make clear distinction between getRemaining == 0 and isFinished == true
      Jonathan Eagles created issue -

        People

        • Assignee:
          Jonathan Eagles
          Reporter:
          Jonathan Eagles
        • Votes:
          0 Vote for this issue
          Watchers:
          3 Start watching this issue

          Dates

          • Created:
            Updated:
            Resolved:

            Development