You are viewing a plain text version of this content. The canonical link for it is here.
Posted to common-dev@hadoop.apache.org by "Konstantin Shvachko (JIRA)" <ji...@apache.org> on 2007/08/21 04:49:30 UTC

[jira] Created: (HADOOP-1742) FSNamesystem.startFile() javadoc is inconsistent

FSNamesystem.startFile()  javadoc is inconsistent
-------------------------------------------------

                 Key: HADOOP-1742
                 URL: https://issues.apache.org/jira/browse/HADOOP-1742
             Project: Hadoop
          Issue Type: Improvement
          Components: dfs
    Affects Versions: 0.14.0
            Reporter: Konstantin Shvachko
            Priority: Minor
             Fix For: 0.15.0


FSNamesystem.startFile()  description should be updated. 
It talks about arrays of blocks that are supposed to be returned, but returns void.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Commented: (HADOOP-1742) FSNamesystem.startFile() javadoc is inconsistent

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

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

+1

> FSNamesystem.startFile()  javadoc is inconsistent
> -------------------------------------------------
>
>                 Key: HADOOP-1742
>                 URL: https://issues.apache.org/jira/browse/HADOOP-1742
>             Project: Hadoop
>          Issue Type: Improvement
>          Components: dfs
>    Affects Versions: 0.14.0
>            Reporter: Konstantin Shvachko
>            Assignee: Konstantin Shvachko
>            Priority: Minor
>             Fix For: 0.16.0
>
>         Attachments: JDocCorrect.patch, JDocCorrect.patch, JDocCorrect.patch, JDocCorrect2.patch
>
>
> FSNamesystem.startFile()  description should be updated. 
> It talks about arrays of blocks that are supposed to be returned, but returns void.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Commented: (HADOOP-1742) FSNamesystem.startFile() javadoc is inconsistent

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

Hadoop QA commented on HADOOP-1742:
-----------------------------------

+1 overall.  Here are the results of testing the latest attachment 
http://issues.apache.org/jira/secure/attachment/12373185/JDocCorrect.patch
against trunk revision r612314.

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

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

    javac +1.  The applied patch does not generate any new compiler warnings.

    findbugs +1.  The patch does not introduce any new Findbugs warnings.

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

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

Test results: http://lucene.zones.apache.org:8080/hudson/job/Hadoop-Patch/1605/testReport/
Findbugs warnings: http://lucene.zones.apache.org:8080/hudson/job/Hadoop-Patch/1605/artifact/trunk/build/test/findbugs/newPatchFindbugsWarnings.html
Checkstyle results: http://lucene.zones.apache.org:8080/hudson/job/Hadoop-Patch/1605/artifact/trunk/build/test/checkstyle-errors.html
Console output: http://lucene.zones.apache.org:8080/hudson/job/Hadoop-Patch/1605/console

This message is automatically generated.

> FSNamesystem.startFile()  javadoc is inconsistent
> -------------------------------------------------
>
>                 Key: HADOOP-1742
>                 URL: https://issues.apache.org/jira/browse/HADOOP-1742
>             Project: Hadoop
>          Issue Type: Improvement
>          Components: dfs
>    Affects Versions: 0.14.0
>            Reporter: Konstantin Shvachko
>            Assignee: Konstantin Shvachko
>            Priority: Minor
>             Fix For: 0.16.0
>
>         Attachments: JDocCorrect.patch, JDocCorrect.patch, JDocCorrect.patch
>
>
> FSNamesystem.startFile()  description should be updated. 
> It talks about arrays of blocks that are supposed to be returned, but returns void.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Updated: (HADOOP-1742) FSNamesystem.startFile() javadoc is inconsistent

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

Konstantin Shvachko updated HADOOP-1742:
----------------------------------------

    Attachment: JDocCorrect.patch

This is JavaDoc only patch.
I changed documentation for startFile() and some other FSNamesystem methods.
I also noticed that our ClientProtocol JavaDoc is outdated in some places. So I wrote some new comments.
DFSClient had a lot of JavaDoc warnings after security patches. I corrected that too.

> FSNamesystem.startFile()  javadoc is inconsistent
> -------------------------------------------------
>
>                 Key: HADOOP-1742
>                 URL: https://issues.apache.org/jira/browse/HADOOP-1742
>             Project: Hadoop
>          Issue Type: Improvement
>          Components: dfs
>    Affects Versions: 0.14.0
>            Reporter: Konstantin Shvachko
>            Priority: Minor
>             Fix For: 0.16.0
>
>         Attachments: JDocCorrect.patch
>
>
> FSNamesystem.startFile()  description should be updated. 
> It talks about arrays of blocks that are supposed to be returned, but returns void.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Updated: (HADOOP-1742) FSNamesystem.startFile() javadoc is inconsistent

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

Konstantin Shvachko updated HADOOP-1742:
----------------------------------------

    Attachment: JDocCorrect.patch

A few spelling corrections.

> FSNamesystem.startFile()  javadoc is inconsistent
> -------------------------------------------------
>
>                 Key: HADOOP-1742
>                 URL: https://issues.apache.org/jira/browse/HADOOP-1742
>             Project: Hadoop
>          Issue Type: Improvement
>          Components: dfs
>    Affects Versions: 0.14.0
>            Reporter: Konstantin Shvachko
>            Assignee: Konstantin Shvachko
>            Priority: Minor
>             Fix For: 0.16.0
>
>         Attachments: JDocCorrect.patch, JDocCorrect.patch
>
>
> FSNamesystem.startFile()  description should be updated. 
> It talks about arrays of blocks that are supposed to be returned, but returns void.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Updated: (HADOOP-1742) FSNamesystem.startFile() javadoc is inconsistent

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

Konstantin Shvachko updated HADOOP-1742:
----------------------------------------

    Resolution: Fixed
        Status: Resolved  (was: Patch Available)

I just committed this.

> FSNamesystem.startFile()  javadoc is inconsistent
> -------------------------------------------------
>
>                 Key: HADOOP-1742
>                 URL: https://issues.apache.org/jira/browse/HADOOP-1742
>             Project: Hadoop
>          Issue Type: Improvement
>          Components: dfs
>    Affects Versions: 0.14.0
>            Reporter: Konstantin Shvachko
>            Assignee: Konstantin Shvachko
>            Priority: Minor
>             Fix For: 0.16.0
>
>         Attachments: JDocCorrect.patch, JDocCorrect.patch, JDocCorrect.patch, JDocCorrect2.patch
>
>
> FSNamesystem.startFile()  description should be updated. 
> It talks about arrays of blocks that are supposed to be returned, but returns void.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Updated: (HADOOP-1742) FSNamesystem.startFile() javadoc is inconsistent

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

Konstantin Shvachko updated HADOOP-1742:
----------------------------------------

    Attachment: JDocCorrect2.patch

I incorporated all comments, added some formatting to JavaDoc, and clarified rename and delete documentations. Thanks, Nicholas.

> FSNamesystem.startFile()  javadoc is inconsistent
> -------------------------------------------------
>
>                 Key: HADOOP-1742
>                 URL: https://issues.apache.org/jira/browse/HADOOP-1742
>             Project: Hadoop
>          Issue Type: Improvement
>          Components: dfs
>    Affects Versions: 0.14.0
>            Reporter: Konstantin Shvachko
>            Assignee: Konstantin Shvachko
>            Priority: Minor
>             Fix For: 0.16.0
>
>         Attachments: JDocCorrect.patch, JDocCorrect.patch, JDocCorrect.patch, JDocCorrect2.patch
>
>
> FSNamesystem.startFile()  description should be updated. 
> It talks about arrays of blocks that are supposed to be returned, but returns void.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Updated: (HADOOP-1742) FSNamesystem.startFile() javadoc is inconsistent

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

Konstantin Shvachko updated HADOOP-1742:
----------------------------------------

    Attachment: JDocCorrect.patch

This reflects current trunk.

> FSNamesystem.startFile()  javadoc is inconsistent
> -------------------------------------------------
>
>                 Key: HADOOP-1742
>                 URL: https://issues.apache.org/jira/browse/HADOOP-1742
>             Project: Hadoop
>          Issue Type: Improvement
>          Components: dfs
>    Affects Versions: 0.14.0
>            Reporter: Konstantin Shvachko
>            Assignee: Konstantin Shvachko
>            Priority: Minor
>             Fix For: 0.16.0
>
>         Attachments: JDocCorrect.patch, JDocCorrect.patch, JDocCorrect.patch
>
>
> FSNamesystem.startFile()  description should be updated. 
> It talks about arrays of blocks that are supposed to be returned, but returns void.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Updated: (HADOOP-1742) FSNamesystem.startFile() javadoc is inconsistent

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

Konstantin Shvachko updated HADOOP-1742:
----------------------------------------

    Fix Version/s: 0.16.0
         Assignee: Konstantin Shvachko
           Status: Patch Available  (was: Open)

> FSNamesystem.startFile()  javadoc is inconsistent
> -------------------------------------------------
>
>                 Key: HADOOP-1742
>                 URL: https://issues.apache.org/jira/browse/HADOOP-1742
>             Project: Hadoop
>          Issue Type: Improvement
>          Components: dfs
>    Affects Versions: 0.14.0
>            Reporter: Konstantin Shvachko
>            Assignee: Konstantin Shvachko
>            Priority: Minor
>             Fix For: 0.16.0
>
>         Attachments: JDocCorrect.patch
>
>
> FSNamesystem.startFile()  description should be updated. 
> It talks about arrays of blocks that are supposed to be returned, but returns void.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Commented: (HADOOP-1742) FSNamesystem.startFile() javadoc is inconsistent

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

Hadoop QA commented on HADOOP-1742:
-----------------------------------

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

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

    patch -1.  The patch command could not apply the patch.

Console output: http://lucene.zones.apache.org:8080/hudson/job/Hadoop-Patch/1593/console

This message is automatically generated.

> FSNamesystem.startFile()  javadoc is inconsistent
> -------------------------------------------------
>
>                 Key: HADOOP-1742
>                 URL: https://issues.apache.org/jira/browse/HADOOP-1742
>             Project: Hadoop
>          Issue Type: Improvement
>          Components: dfs
>    Affects Versions: 0.14.0
>            Reporter: Konstantin Shvachko
>            Assignee: Konstantin Shvachko
>            Priority: Minor
>             Fix For: 0.16.0
>
>         Attachments: JDocCorrect.patch, JDocCorrect.patch
>
>
> FSNamesystem.startFile()  description should be updated. 
> It talks about arrays of blocks that are supposed to be returned, but returns void.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Updated: (HADOOP-1742) FSNamesystem.startFile() javadoc is inconsistent

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

Konstantin Shvachko updated HADOOP-1742:
----------------------------------------

    Status: Patch Available  (was: Open)

> FSNamesystem.startFile()  javadoc is inconsistent
> -------------------------------------------------
>
>                 Key: HADOOP-1742
>                 URL: https://issues.apache.org/jira/browse/HADOOP-1742
>             Project: Hadoop
>          Issue Type: Improvement
>          Components: dfs
>    Affects Versions: 0.14.0
>            Reporter: Konstantin Shvachko
>            Assignee: Konstantin Shvachko
>            Priority: Minor
>             Fix For: 0.16.0
>
>         Attachments: JDocCorrect.patch, JDocCorrect.patch, JDocCorrect.patch
>
>
> FSNamesystem.startFile()  description should be updated. 
> It talks about arrays of blocks that are supposed to be returned, but returns void.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Commented: (HADOOP-1742) FSNamesystem.startFile() javadoc is inconsistent

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

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

Thank you for fixing the docs.  I have a few comments below.

- In ClientProtocol:
line 92: add a comma after "Once created"
line 95: add "by" after "abandoned implicitly"
line 111: wraped => wrapped

- Some javadocs (e.g. ClientProtocol.create(...)) are showed in single big paragraphs in the generated html.  I suggest to use <p> tag (instead of empty lines) to enclose paragraphs.

- Could you also remove the unrelated docs above DFSClient.rename(...) and DFSClient.delete(...)?

> FSNamesystem.startFile()  javadoc is inconsistent
> -------------------------------------------------
>
>                 Key: HADOOP-1742
>                 URL: https://issues.apache.org/jira/browse/HADOOP-1742
>             Project: Hadoop
>          Issue Type: Improvement
>          Components: dfs
>    Affects Versions: 0.14.0
>            Reporter: Konstantin Shvachko
>            Assignee: Konstantin Shvachko
>            Priority: Minor
>             Fix For: 0.16.0
>
>         Attachments: JDocCorrect.patch, JDocCorrect.patch, JDocCorrect.patch
>
>
> FSNamesystem.startFile()  description should be updated. 
> It talks about arrays of blocks that are supposed to be returned, but returns void.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Updated: (HADOOP-1742) FSNamesystem.startFile() javadoc is inconsistent

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

Konstantin Shvachko updated HADOOP-1742:
----------------------------------------

    Status: Open  (was: Patch Available)

> FSNamesystem.startFile()  javadoc is inconsistent
> -------------------------------------------------
>
>                 Key: HADOOP-1742
>                 URL: https://issues.apache.org/jira/browse/HADOOP-1742
>             Project: Hadoop
>          Issue Type: Improvement
>          Components: dfs
>    Affects Versions: 0.14.0
>            Reporter: Konstantin Shvachko
>            Assignee: Konstantin Shvachko
>            Priority: Minor
>             Fix For: 0.16.0
>
>         Attachments: JDocCorrect.patch, JDocCorrect.patch, JDocCorrect.patch
>
>
> FSNamesystem.startFile()  description should be updated. 
> It talks about arrays of blocks that are supposed to be returned, but returns void.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.