You are viewing a plain text version of this content. The canonical link for it is here.
Posted to common-issues@hadoop.apache.org by "Jonathan Hsieh (JIRA)" <ji...@apache.org> on 2011/05/21 01:31:47 UTC

[jira] [Created] (HADOOP-7316) Add javadoc comments to FSDataInputStream.getWrappedStream public method.

Add javadoc comments to FSDataInputStream.getWrappedStream public method.
-------------------------------------------------------------------------

                 Key: HADOOP-7316
                 URL: https://issues.apache.org/jira/browse/HADOOP-7316
             Project: Hadoop Common
          Issue Type: New Feature
            Reporter: Jonathan Hsieh
             Fix For: 0.23.0


This is a method made public for testing.  In comments in HADOOP-7301 after commit, adding javadoc comments was requested.  This is a follow up jira to address it.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Updated] (HADOOP-7316) Add public javadocs to FSDataInputStream and FSDataOutputStream

Posted by "Eli Collins (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/HADOOP-7316?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Eli Collins updated HADOOP-7316:
--------------------------------

    Attachment: hadoop-7316-1.patch

Patch attached. Also fixes a couple minor javadoc errors in FsCommand and Command.

> Add public javadocs to FSDataInputStream and FSDataOutputStream
> ---------------------------------------------------------------
>
>                 Key: HADOOP-7316
>                 URL: https://issues.apache.org/jira/browse/HADOOP-7316
>             Project: Hadoop Common
>          Issue Type: New Feature
>            Reporter: Jonathan Hsieh
>            Assignee: Eli Collins
>             Fix For: 0.23.0
>
>         Attachments: hadoop-7316-1.patch
>
>
> This is a method made public for testing.  In comments in HADOOP-7301 after commit, adding javadoc comments was requested.  This is a follow up jira to address it.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Commented] (HADOOP-7316) Add public javadocs to FSDataInputStream and FSDataOutputStream

Posted by "Hudson (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/HADOOP-7316?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13044109#comment-13044109 ] 

Hudson commented on HADOOP-7316:
--------------------------------

Integrated in Hadoop-Common-trunk-Commit #638 (See [https://builds.apache.org/hudson/job/Hadoop-Common-trunk-Commit/638/])
    HADOOP-7316. Add public javadocs to FSDataInputStream and FSDataOutputStream. Contributed by Eli Collins

eli : http://svn.apache.org/viewcvs.cgi/?root=Apache-SVN&view=rev&rev=1131268
Files : 
* /hadoop/common/trunk/src/java/org/apache/hadoop/fs/shell/FsCommand.java
* /hadoop/common/trunk/CHANGES.txt
* /hadoop/common/trunk/src/java/org/apache/hadoop/fs/shell/Command.java
* /hadoop/common/trunk/src/java/org/apache/hadoop/fs/PositionedReadable.java
* /hadoop/common/trunk/src/java/org/apache/hadoop/fs/FSDataOutputStream.java
* /hadoop/common/trunk/src/java/org/apache/hadoop/fs/FSDataInputStream.java


> Add public javadocs to FSDataInputStream and FSDataOutputStream
> ---------------------------------------------------------------
>
>                 Key: HADOOP-7316
>                 URL: https://issues.apache.org/jira/browse/HADOOP-7316
>             Project: Hadoop Common
>          Issue Type: Improvement
>          Components: documentation
>            Reporter: Jonathan Hsieh
>            Assignee: Eli Collins
>             Fix For: 0.23.0
>
>         Attachments: hadoop-7316-1.patch, hadoop-7316-2.patch, hadoop-7316-3.patch
>
>
> This is a method made public for testing.  In comments in HADOOP-7301 after commit, adding javadoc comments was requested.  This is a follow up jira to address it.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Commented] (HADOOP-7316) Add public javadocs to FSDataInputStream and FSDataOutputStream

Posted by "John George (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/HADOOP-7316?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13044121#comment-13044121 ] 

John George commented on HADOOP-7316:
-------------------------------------

Just to understand this a little better:
Is the read() function also not expected to throw an EOF Exception if the user tried to read beyond EOF? 

> Add public javadocs to FSDataInputStream and FSDataOutputStream
> ---------------------------------------------------------------
>
>                 Key: HADOOP-7316
>                 URL: https://issues.apache.org/jira/browse/HADOOP-7316
>             Project: Hadoop Common
>          Issue Type: Improvement
>          Components: documentation
>            Reporter: Jonathan Hsieh
>            Assignee: Eli Collins
>             Fix For: 0.23.0
>
>         Attachments: hadoop-7316-1.patch, hadoop-7316-2.patch, hadoop-7316-3.patch
>
>
> This is a method made public for testing.  In comments in HADOOP-7301 after commit, adding javadoc comments was requested.  This is a follow up jira to address it.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Commented] (HADOOP-7316) Add public javadocs to FSDataInputStream and FSDataOutputStream

Posted by "Todd Lipcon (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/HADOOP-7316?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13044138#comment-13044138 ] 

Todd Lipcon commented on HADOOP-7316:
-------------------------------------

bq. DFSInputStream#seek should really throw an EOFException if seeking beyond the end of stream, but changing it to do that now would break compatibility =(

Actually, Java's RandomAccessFile API lets you seek way past the end of a file with no exception. The next read() call will simply return -1. But asking for "position()" on the file's channel continues to return the past-eof offset.

> Add public javadocs to FSDataInputStream and FSDataOutputStream
> ---------------------------------------------------------------
>
>                 Key: HADOOP-7316
>                 URL: https://issues.apache.org/jira/browse/HADOOP-7316
>             Project: Hadoop Common
>          Issue Type: Improvement
>          Components: documentation
>            Reporter: Jonathan Hsieh
>            Assignee: Eli Collins
>             Fix For: 0.23.0
>
>         Attachments: hadoop-7316-1.patch, hadoop-7316-2.patch, hadoop-7316-3.patch
>
>
> This is a method made public for testing.  In comments in HADOOP-7301 after commit, adding javadoc comments was requested.  This is a follow up jira to address it.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Updated] (HADOOP-7316) Add public javadocs to FSDataInputStream and FSDataOutputStream

Posted by "Eli Collins (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/HADOOP-7316?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Eli Collins updated HADOOP-7316:
--------------------------------

    Assignee: Eli Collins
     Summary: Add public javadocs to FSDataInputStream and FSDataOutputStream  (was: Add javadoc comments to FSDataInputStream.getWrappedStream public method.)

Might as well do this for all public methods in both FSDataInputStream and FSDataOutputStream.

> Add public javadocs to FSDataInputStream and FSDataOutputStream
> ---------------------------------------------------------------
>
>                 Key: HADOOP-7316
>                 URL: https://issues.apache.org/jira/browse/HADOOP-7316
>             Project: Hadoop Common
>          Issue Type: New Feature
>            Reporter: Jonathan Hsieh
>            Assignee: Eli Collins
>             Fix For: 0.23.0
>
>
> This is a method made public for testing.  In comments in HADOOP-7301 after commit, adding javadoc comments was requested.  This is a follow up jira to address it.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Updated] (HADOOP-7316) Add public javadocs to FSDataInputStream and FSDataOutputStream

Posted by "Eli Collins (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/HADOOP-7316?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Eli Collins updated HADOOP-7316:
--------------------------------

    Status: Patch Available  (was: Open)

> Add public javadocs to FSDataInputStream and FSDataOutputStream
> ---------------------------------------------------------------
>
>                 Key: HADOOP-7316
>                 URL: https://issues.apache.org/jira/browse/HADOOP-7316
>             Project: Hadoop Common
>          Issue Type: New Feature
>            Reporter: Jonathan Hsieh
>            Assignee: Eli Collins
>             Fix For: 0.23.0
>
>         Attachments: hadoop-7316-1.patch
>
>
> This is a method made public for testing.  In comments in HADOOP-7301 after commit, adding javadoc comments was requested.  This is a follow up jira to address it.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Commented] (HADOOP-7316) Add public javadocs to FSDataInputStream and FSDataOutputStream

Posted by "Todd Lipcon (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/HADOOP-7316?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13044088#comment-13044088 ] 

Todd Lipcon commented on HADOOP-7316:
-------------------------------------

+1 pending hudson

> Add public javadocs to FSDataInputStream and FSDataOutputStream
> ---------------------------------------------------------------
>
>                 Key: HADOOP-7316
>                 URL: https://issues.apache.org/jira/browse/HADOOP-7316
>             Project: Hadoop Common
>          Issue Type: Improvement
>          Components: documentation
>            Reporter: Jonathan Hsieh
>            Assignee: Eli Collins
>             Fix For: 0.23.0
>
>         Attachments: hadoop-7316-1.patch, hadoop-7316-2.patch, hadoop-7316-3.patch
>
>
> This is a method made public for testing.  In comments in HADOOP-7301 after commit, adding javadoc comments was requested.  This is a follow up jira to address it.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Updated] (HADOOP-7316) Add public javadocs to FSDataInputStream and FSDataOutputStream

Posted by "Tsz Wo (Nicholas), SZE (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/HADOOP-7316?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Tsz Wo (Nicholas), SZE updated HADOOP-7316:
-------------------------------------------

    Component/s: documentation
     Issue Type: Improvement  (was: New Feature)

> Add public javadocs to FSDataInputStream and FSDataOutputStream
> ---------------------------------------------------------------
>
>                 Key: HADOOP-7316
>                 URL: https://issues.apache.org/jira/browse/HADOOP-7316
>             Project: Hadoop Common
>          Issue Type: Improvement
>          Components: documentation
>            Reporter: Jonathan Hsieh
>            Assignee: Eli Collins
>             Fix For: 0.23.0
>
>         Attachments: hadoop-7316-1.patch
>
>
> This is a method made public for testing.  In comments in HADOOP-7301 after commit, adding javadoc comments was requested.  This is a follow up jira to address it.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Commented] (HADOOP-7316) Add public javadocs to FSDataInputStream and FSDataOutputStream

Posted by "Todd Lipcon (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/HADOOP-7316?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13043937#comment-13043937 ] 

Todd Lipcon commented on HADOOP-7316:
-------------------------------------

Super nitty review on the javadoc:
- Javadoc style guide at http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html says the following about punctuation and capitalization for @param and @return:
{quote}
The description begins with a lowercase letter if it is a phrase (contains no verb), or an uppercase letter if it is a sentence. End the phrase with a period only if another phrase or sentence follows it.
{quote}
(ie the @param and @returns should start with lower case letters)

- following should read "the buffer *into* which data is read" in two places:
+   * @param buffer    The buffer in which data is read.

- for the readFully javadoc, @param length should say "the exact number of bytes to read" or "the number of bytes" rather than "the maximum" given the contract of readFully.
- for readFully, we should also specify that, even if it throws an exception, it may modify an undetermined number of bytes in the target buffer.
- typo: "altenate" should be "alternate"





> Add public javadocs to FSDataInputStream and FSDataOutputStream
> ---------------------------------------------------------------
>
>                 Key: HADOOP-7316
>                 URL: https://issues.apache.org/jira/browse/HADOOP-7316
>             Project: Hadoop Common
>          Issue Type: Improvement
>          Components: documentation
>            Reporter: Jonathan Hsieh
>            Assignee: Eli Collins
>             Fix For: 0.23.0
>
>         Attachments: hadoop-7316-1.patch, hadoop-7316-2.patch
>
>
> This is a method made public for testing.  In comments in HADOOP-7301 after commit, adding javadoc comments was requested.  This is a follow up jira to address it.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Updated] (HADOOP-7316) Add public javadocs to FSDataInputStream and FSDataOutputStream

Posted by "Eli Collins (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/HADOOP-7316?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Eli Collins updated HADOOP-7316:
--------------------------------

    Attachment: hadoop-7316-3.patch

Thanks Todd. Updated patch attached.

> Add public javadocs to FSDataInputStream and FSDataOutputStream
> ---------------------------------------------------------------
>
>                 Key: HADOOP-7316
>                 URL: https://issues.apache.org/jira/browse/HADOOP-7316
>             Project: Hadoop Common
>          Issue Type: Improvement
>          Components: documentation
>            Reporter: Jonathan Hsieh
>            Assignee: Eli Collins
>             Fix For: 0.23.0
>
>         Attachments: hadoop-7316-1.patch, hadoop-7316-2.patch, hadoop-7316-3.patch
>
>
> This is a method made public for testing.  In comments in HADOOP-7301 after commit, adding javadoc comments was requested.  This is a follow up jira to address it.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Commented] (HADOOP-7316) Add public javadocs to FSDataInputStream and FSDataOutputStream

Posted by "Hudson (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/HADOOP-7316?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13044276#comment-13044276 ] 

Hudson commented on HADOOP-7316:
--------------------------------

Integrated in Hadoop-Common-trunk #709 (See [https://builds.apache.org/hudson/job/Hadoop-Common-trunk/709/])
    HADOOP-7316. Add public javadocs to FSDataInputStream and FSDataOutputStream. Contributed by Eli Collins

eli : http://svn.apache.org/viewcvs.cgi/?root=Apache-SVN&view=rev&rev=1131268
Files : 
* /hadoop/common/trunk/src/java/org/apache/hadoop/fs/shell/FsCommand.java
* /hadoop/common/trunk/CHANGES.txt
* /hadoop/common/trunk/src/java/org/apache/hadoop/fs/shell/Command.java
* /hadoop/common/trunk/src/java/org/apache/hadoop/fs/PositionedReadable.java
* /hadoop/common/trunk/src/java/org/apache/hadoop/fs/FSDataOutputStream.java
* /hadoop/common/trunk/src/java/org/apache/hadoop/fs/FSDataInputStream.java


> Add public javadocs to FSDataInputStream and FSDataOutputStream
> ---------------------------------------------------------------
>
>                 Key: HADOOP-7316
>                 URL: https://issues.apache.org/jira/browse/HADOOP-7316
>             Project: Hadoop Common
>          Issue Type: Improvement
>          Components: documentation
>            Reporter: Jonathan Hsieh
>            Assignee: Eli Collins
>             Fix For: 0.23.0
>
>         Attachments: hadoop-7316-1.patch, hadoop-7316-2.patch, hadoop-7316-3.patch
>
>
> This is a method made public for testing.  In comments in HADOOP-7301 after commit, adding javadoc comments was requested.  This is a follow up jira to address it.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Commented] (HADOOP-7316) Add public javadocs to FSDataInputStream and FSDataOutputStream

Posted by "Eli Collins (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/HADOOP-7316?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13044148#comment-13044148 ] 

Eli Collins commented on HADOOP-7316:
-------------------------------------

Go for it!

> Add public javadocs to FSDataInputStream and FSDataOutputStream
> ---------------------------------------------------------------
>
>                 Key: HADOOP-7316
>                 URL: https://issues.apache.org/jira/browse/HADOOP-7316
>             Project: Hadoop Common
>          Issue Type: Improvement
>          Components: documentation
>            Reporter: Jonathan Hsieh
>            Assignee: Eli Collins
>             Fix For: 0.23.0
>
>         Attachments: hadoop-7316-1.patch, hadoop-7316-2.patch, hadoop-7316-3.patch
>
>
> This is a method made public for testing.  In comments in HADOOP-7301 after commit, adding javadoc comments was requested.  This is a follow up jira to address it.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Commented] (HADOOP-7316) Add public javadocs to FSDataInputStream and FSDataOutputStream

Posted by "Eli Collins (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/HADOOP-7316?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13041928#comment-13041928 ] 

Eli Collins commented on HADOOP-7316:
-------------------------------------

Hey Owen - is the latest patch acceptable to you?

> Add public javadocs to FSDataInputStream and FSDataOutputStream
> ---------------------------------------------------------------
>
>                 Key: HADOOP-7316
>                 URL: https://issues.apache.org/jira/browse/HADOOP-7316
>             Project: Hadoop Common
>          Issue Type: Improvement
>          Components: documentation
>            Reporter: Jonathan Hsieh
>            Assignee: Eli Collins
>             Fix For: 0.23.0
>
>         Attachments: hadoop-7316-1.patch, hadoop-7316-2.patch
>
>
> This is a method made public for testing.  In comments in HADOOP-7301 after commit, adding javadoc comments was requested.  This is a follow up jira to address it.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Commented] (HADOOP-7316) Add public javadocs to FSDataInputStream and FSDataOutputStream

Posted by "Hadoop QA (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/HADOOP-7316?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13044094#comment-13044094 ] 

Hadoop QA commented on HADOOP-7316:
-----------------------------------

+1 overall.  Here are the results of testing the latest attachment 
  http://issues.apache.org/jira/secure/attachment/12481412/hadoop-7316-3.patch
  against trunk revision 1131254.

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

    +0 tests included.  The patch appears to be a documentation patch that doesn't require tests.

    +1 javadoc.  The javadoc tool did not generate any warning messages.

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

    +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 core unit tests.

    +1 system test framework.  The patch passed system test framework compile.

Test results: https://builds.apache.org/hudson/job/PreCommit-HADOOP-Build/575//testReport/
Findbugs warnings: https://builds.apache.org/hudson/job/PreCommit-HADOOP-Build/575//artifact/trunk/build/test/findbugs/newPatchFindbugsWarnings.html
Console output: https://builds.apache.org/hudson/job/PreCommit-HADOOP-Build/575//console

This message is automatically generated.

> Add public javadocs to FSDataInputStream and FSDataOutputStream
> ---------------------------------------------------------------
>
>                 Key: HADOOP-7316
>                 URL: https://issues.apache.org/jira/browse/HADOOP-7316
>             Project: Hadoop Common
>          Issue Type: Improvement
>          Components: documentation
>            Reporter: Jonathan Hsieh
>            Assignee: Eli Collins
>             Fix For: 0.23.0
>
>         Attachments: hadoop-7316-1.patch, hadoop-7316-2.patch, hadoop-7316-3.patch
>
>
> This is a method made public for testing.  In comments in HADOOP-7301 after commit, adding javadoc comments was requested.  This is a follow up jira to address it.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Updated] (HADOOP-7316) Add public javadocs to FSDataInputStream and FSDataOutputStream

Posted by "Owen O'Malley (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/HADOOP-7316?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Owen O'Malley updated HADOOP-7316:
----------------------------------

    Status: Open  (was: Patch Available)

The newly visible method should be annotated with interface audience private.

Why was it necessary to make this method public instead of package visible? All testing should be able to use that.

> Add public javadocs to FSDataInputStream and FSDataOutputStream
> ---------------------------------------------------------------
>
>                 Key: HADOOP-7316
>                 URL: https://issues.apache.org/jira/browse/HADOOP-7316
>             Project: Hadoop Common
>          Issue Type: New Feature
>            Reporter: Jonathan Hsieh
>            Assignee: Eli Collins
>             Fix For: 0.23.0
>
>         Attachments: hadoop-7316-1.patch
>
>
> This is a method made public for testing.  In comments in HADOOP-7301 after commit, adding javadoc comments was requested.  This is a follow up jira to address it.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Updated] (HADOOP-7316) Add public javadocs to FSDataInputStream and FSDataOutputStream

Posted by "Eli Collins (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/HADOOP-7316?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Eli Collins updated HADOOP-7316:
--------------------------------

    Attachment: hadoop-7316-2.patch

Thanks Owen.  Updated patch attached. 

I marked both FSDataInputStream and FSDataOutputStream#getWrappedStream LimitedPrivate to HDFS.

The addition of FSDataInputStream#getWrappedStream mirrors the same method in FSDataOutputStream. Both live in common but are just used for HDFS tests, which is why they are not package visible. Could also expose these via a test  adapter class but I think the annotation is sufficient.

> Add public javadocs to FSDataInputStream and FSDataOutputStream
> ---------------------------------------------------------------
>
>                 Key: HADOOP-7316
>                 URL: https://issues.apache.org/jira/browse/HADOOP-7316
>             Project: Hadoop Common
>          Issue Type: Improvement
>          Components: documentation
>            Reporter: Jonathan Hsieh
>            Assignee: Eli Collins
>             Fix For: 0.23.0
>
>         Attachments: hadoop-7316-1.patch, hadoop-7316-2.patch
>
>
> This is a method made public for testing.  In comments in HADOOP-7301 after commit, adding javadoc comments was requested.  This is a follow up jira to address it.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Commented] (HADOOP-7316) Add public javadocs to FSDataInputStream and FSDataOutputStream

Posted by "Eli Collins (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/HADOOP-7316?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13044134#comment-13044134 ] 

Eli Collins commented on HADOOP-7316:
-------------------------------------

Depends on the underlying InputStream. read (and readFully) result in a call to seek, which in the case of DFSInputStream throws an IOException if you try to seek past the length of the files. FSInputStream#readFully however throws an EOFException if the underlying call to read failed while FSInputStream#read will return whatever value the underlying call to read returned (will not throw an EOFException). So, per the javadoc, you only get the EOFException with readFully if you hit the EOF while reading.

DFSInputStream#seek should really throw an EOFException if seeking beyond the end of stream, but changing it to do that now would break compatibility =(

> Add public javadocs to FSDataInputStream and FSDataOutputStream
> ---------------------------------------------------------------
>
>                 Key: HADOOP-7316
>                 URL: https://issues.apache.org/jira/browse/HADOOP-7316
>             Project: Hadoop Common
>          Issue Type: Improvement
>          Components: documentation
>            Reporter: Jonathan Hsieh
>            Assignee: Eli Collins
>             Fix For: 0.23.0
>
>         Attachments: hadoop-7316-1.patch, hadoop-7316-2.patch, hadoop-7316-3.patch
>
>
> This is a method made public for testing.  In comments in HADOOP-7301 after commit, adding javadoc comments was requested.  This is a follow up jira to address it.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Commented] (HADOOP-7316) Add public javadocs to FSDataInputStream and FSDataOutputStream

Posted by "Tsz Wo (Nicholas), SZE (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/HADOOP-7316?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13044158#comment-13044158 ] 

Tsz Wo (Nicholas), SZE commented on HADOOP-7316:
------------------------------------------------

> ... Because Daryn and I were both confused about the behavior ...

Hi John, I think the current behavior is not well designed.  If it is the case, you may also fix it.

> Add public javadocs to FSDataInputStream and FSDataOutputStream
> ---------------------------------------------------------------
>
>                 Key: HADOOP-7316
>                 URL: https://issues.apache.org/jira/browse/HADOOP-7316
>             Project: Hadoop Common
>          Issue Type: Improvement
>          Components: documentation
>            Reporter: Jonathan Hsieh
>            Assignee: Eli Collins
>             Fix For: 0.23.0
>
>         Attachments: hadoop-7316-1.patch, hadoop-7316-2.patch, hadoop-7316-3.patch
>
>
> This is a method made public for testing.  In comments in HADOOP-7301 after commit, adding javadoc comments was requested.  This is a follow up jira to address it.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Commented] (HADOOP-7316) Add public javadocs to FSDataInputStream and FSDataOutputStream

Posted by "John George (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/HADOOP-7316?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13044144#comment-13044144 ] 

John George commented on HADOOP-7316:
-------------------------------------

Thanks a lot Todd and Eli.
Is it okay if I add this as a comment to DFSInputStream at some point? Because Daryn and I were both confused about the behavior and the above information really helps.

> Add public javadocs to FSDataInputStream and FSDataOutputStream
> ---------------------------------------------------------------
>
>                 Key: HADOOP-7316
>                 URL: https://issues.apache.org/jira/browse/HADOOP-7316
>             Project: Hadoop Common
>          Issue Type: Improvement
>          Components: documentation
>            Reporter: Jonathan Hsieh
>            Assignee: Eli Collins
>             Fix For: 0.23.0
>
>         Attachments: hadoop-7316-1.patch, hadoop-7316-2.patch, hadoop-7316-3.patch
>
>
> This is a method made public for testing.  In comments in HADOOP-7301 after commit, adding javadoc comments was requested.  This is a follow up jira to address it.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Commented] (HADOOP-7316) Add public javadocs to FSDataInputStream and FSDataOutputStream

Posted by "John George (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/HADOOP-7316?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13044198#comment-13044198 ] 

John George commented on HADOOP-7316:
-------------------------------------

>> ... Because Daryn and I were both confused about the behavior ...

> Hi John, I think the current behavior is not well designed. If it is the case, you may also fix it.

Thanks Nicholas. I created HDFS-2033 to track read path design.

> Add public javadocs to FSDataInputStream and FSDataOutputStream
> ---------------------------------------------------------------
>
>                 Key: HADOOP-7316
>                 URL: https://issues.apache.org/jira/browse/HADOOP-7316
>             Project: Hadoop Common
>          Issue Type: Improvement
>          Components: documentation
>            Reporter: Jonathan Hsieh
>            Assignee: Eli Collins
>             Fix For: 0.23.0
>
>         Attachments: hadoop-7316-1.patch, hadoop-7316-2.patch, hadoop-7316-3.patch
>
>
> This is a method made public for testing.  In comments in HADOOP-7301 after commit, adding javadoc comments was requested.  This is a follow up jira to address it.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Updated] (HADOOP-7316) Add public javadocs to FSDataInputStream and FSDataOutputStream

Posted by "Eli Collins (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/HADOOP-7316?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Eli Collins updated HADOOP-7316:
--------------------------------

    Status: Patch Available  (was: Open)

> Add public javadocs to FSDataInputStream and FSDataOutputStream
> ---------------------------------------------------------------
>
>                 Key: HADOOP-7316
>                 URL: https://issues.apache.org/jira/browse/HADOOP-7316
>             Project: Hadoop Common
>          Issue Type: Improvement
>          Components: documentation
>            Reporter: Jonathan Hsieh
>            Assignee: Eli Collins
>             Fix For: 0.23.0
>
>         Attachments: hadoop-7316-1.patch, hadoop-7316-2.patch, hadoop-7316-3.patch
>
>
> This is a method made public for testing.  In comments in HADOOP-7301 after commit, adding javadoc comments was requested.  This is a follow up jira to address it.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Updated] (HADOOP-7316) Add public javadocs to FSDataInputStream and FSDataOutputStream

Posted by "Eli Collins (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/HADOOP-7316?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Eli Collins updated HADOOP-7316:
--------------------------------

      Resolution: Fixed
    Hadoop Flags: [Reviewed]
          Status: Resolved  (was: Patch Available)

Thanks Todd! I've committed this.

> Add public javadocs to FSDataInputStream and FSDataOutputStream
> ---------------------------------------------------------------
>
>                 Key: HADOOP-7316
>                 URL: https://issues.apache.org/jira/browse/HADOOP-7316
>             Project: Hadoop Common
>          Issue Type: Improvement
>          Components: documentation
>            Reporter: Jonathan Hsieh
>            Assignee: Eli Collins
>             Fix For: 0.23.0
>
>         Attachments: hadoop-7316-1.patch, hadoop-7316-2.patch, hadoop-7316-3.patch
>
>
> This is a method made public for testing.  In comments in HADOOP-7301 after commit, adding javadoc comments was requested.  This is a follow up jira to address it.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira