Details

    • Type: Improvement
    • Status: Resolved
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: 3.0.0-alpha1
    • Fix Version/s: 3.0.0-alpha1
    • Component/s: None
    • Labels:
      None
    • Hadoop Flags:
      Reviewed

      Description

      FileContext javadoc is currently kind of hard to read. Since it is a user API, it would be nice to improve it.

      1. hadoop-9277-3.patch
        7 kB
        Andrew Wang
      2. hadoop-9277-2.patch
        7 kB
        Andrew Wang
      3. hadoop-9277-1.patch
        8 kB
        Andrew Wang

        Activity

        Hide
        andrew.wang Andrew Wang added a comment -

        Patch attached, I hope it's easier to understand. No tests because it's just an update to the javadoc.

        Show
        andrew.wang Andrew Wang added a comment - Patch attached, I hope it's easier to understand. No tests because it's just an update to the javadoc.
        Hide
        hadoopqa Hadoop QA added a comment -

        -1 overall. Here are the results of testing the latest attachment
        http://issues.apache.org/jira/secure/attachment/12567901/hadoop-9277-1.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 javac. The applied patch does not increase the total number of javac compiler warnings.

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

        +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 hadoop-common-project/hadoop-common.

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

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

        This message is automatically generated.

        Show
        hadoopqa Hadoop QA added a comment - -1 overall . Here are the results of testing the latest attachment http://issues.apache.org/jira/secure/attachment/12567901/hadoop-9277-1.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 javac . The applied patch does not increase the total number of javac compiler warnings. +1 javadoc . The javadoc tool did not generate any warning messages. +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 hadoop-common-project/hadoop-common. +1 contrib tests . The patch passed contrib unit tests. Test results: https://builds.apache.org/job/PreCommit-HADOOP-Build/2144//testReport/ Console output: https://builds.apache.org/job/PreCommit-HADOOP-Build/2144//console This message is automatically generated.
        Hide
        sureshms Suresh Srinivas added a comment -

        FileContext javadoc is currently kind of hard to read. Since it is a user API, it would be nice to improve it.

        You mean hard to read as javadoc or in the code?

        Show
        sureshms Suresh Srinivas added a comment - FileContext javadoc is currently kind of hard to read. Since it is a user API, it would be nice to improve it. You mean hard to read as javadoc or in the code?
        Hide
        andrew.wang Andrew Wang added a comment -

        As javadoc I think. If you look at the patch, I basically redid some of it following the existing organization and content, in addition to fixing small nits.

        Show
        andrew.wang Andrew Wang added a comment - As javadoc I think. If you look at the patch, I basically redid some of it following the existing organization and content, in addition to fixing small nits.
        Hide
        sureshms Suresh Srinivas added a comment -

        Sorry, I took a quick look at the patch and noticed many white space changes. If you revert the white space changes, it will be very clear what the changes are.

        Show
        sureshms Suresh Srinivas added a comment - Sorry, I took a quick look at the patch and noticed many white space changes. If you revert the white space changes, it will be very clear what the changes are.
        Hide
        sureshms Suresh Srinivas added a comment -

        BTW with your edits, the javadoc reads much better.

        Show
        sureshms Suresh Srinivas added a comment - BTW with your edits, the javadoc reads much better.
        Hide
        andrew.wang Andrew Wang added a comment -

        Thanks for the feedback, Suresh. I tried to restore the whitespace where possible and minimize the diff. I hope this one is easier to review.

        Show
        andrew.wang Andrew Wang added a comment - Thanks for the feedback, Suresh. I tried to restore the whitespace where possible and minimize the diff. I hope this one is easier to review.
        Hide
        hadoopqa Hadoop QA added a comment -

        -1 overall. Here are the results of testing the latest attachment
        http://issues.apache.org/jira/secure/attachment/12567915/hadoop-9277-2.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 javac. The applied patch does not increase the total number of javac compiler warnings.

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

        +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 hadoop-common-project/hadoop-common.

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

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

        This message is automatically generated.

        Show
        hadoopqa Hadoop QA added a comment - -1 overall . Here are the results of testing the latest attachment http://issues.apache.org/jira/secure/attachment/12567915/hadoop-9277-2.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 javac . The applied patch does not increase the total number of javac compiler warnings. +1 javadoc . The javadoc tool did not generate any warning messages. +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 hadoop-common-project/hadoop-common. +1 contrib tests . The patch passed contrib unit tests. Test results: https://builds.apache.org/job/PreCommit-HADOOP-Build/2145//testReport/ Console output: https://builds.apache.org/job/PreCommit-HADOOP-Build/2145//console This message is automatically generated.
        Hide
        sureshms Suresh Srinivas added a comment -

        Few comments:

        1. Can you please retain "file system" instead of changing it to "filesystem"
        2. Optional - There are parts in the documentation where headings have "*** <heading ***". This does not look good in the javadoc. Also these headings have <p> before and after. The one that is after the heading can be replaced by <br> to make it better readable.
        Show
        sureshms Suresh Srinivas added a comment - Few comments: Can you please retain "file system" instead of changing it to "filesystem" Optional - There are parts in the documentation where headings have "*** <heading ***". This does not look good in the javadoc. Also these headings have <p> before and after. The one that is after the heading can be replaced by <br> to make it better readable.
        Hide
        andrew.wang Andrew Wang added a comment -

        Addressed comments. According to Oracle's javadoc standards, it's okay to use header tags in class javadoc, so I used <h2>'s instead of the <p><b> combination.

        Show
        andrew.wang Andrew Wang added a comment - Addressed comments. According to Oracle's javadoc standards, it's okay to use header tags in class javadoc, so I used <h2>'s instead of the <p><b> combination.
        Hide
        sureshms Suresh Srinivas added a comment -

        <h2> looks much better. +1 for the patch. I will commit it shortly.

        Show
        sureshms Suresh Srinivas added a comment - <h2> looks much better. +1 for the patch. I will commit it shortly.
        Hide
        hadoopqa Hadoop QA added a comment -

        -1 overall. Here are the results of testing the latest attachment
        http://issues.apache.org/jira/secure/attachment/12568444/hadoop-9277-3.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 javac. The applied patch does not increase the total number of javac compiler warnings.

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

        +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 hadoop-common-project/hadoop-common.

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

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

        This message is automatically generated.

        Show
        hadoopqa Hadoop QA added a comment - -1 overall . Here are the results of testing the latest attachment http://issues.apache.org/jira/secure/attachment/12568444/hadoop-9277-3.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 javac . The applied patch does not increase the total number of javac compiler warnings. +1 javadoc . The javadoc tool did not generate any warning messages. +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 hadoop-common-project/hadoop-common. +1 contrib tests . The patch passed contrib unit tests. Test results: https://builds.apache.org/job/PreCommit-HADOOP-Build/2162//testReport/ Console output: https://builds.apache.org/job/PreCommit-HADOOP-Build/2162//console This message is automatically generated.
        Hide
        sureshms Suresh Srinivas added a comment -

        Committed the patch to trunk. Thank you Andrew!

        Show
        sureshms Suresh Srinivas added a comment - Committed the patch to trunk. Thank you Andrew!
        Hide
        hudson Hudson added a comment -

        Integrated in Hadoop-trunk-Commit #3341 (See https://builds.apache.org/job/Hadoop-trunk-Commit/3341/)
        HADOOP-9277. Improve javadoc for FileContext. Contributed by Andrew Wang. (Revision 1443710)

        Result = SUCCESS
        suresh : http://svn.apache.org/viewcvs.cgi/?root=Apache-SVN&view=rev&rev=1443710
        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/fs/FileContext.java
        Show
        hudson Hudson added a comment - Integrated in Hadoop-trunk-Commit #3341 (See https://builds.apache.org/job/Hadoop-trunk-Commit/3341/ ) HADOOP-9277 . Improve javadoc for FileContext. Contributed by Andrew Wang. (Revision 1443710) Result = SUCCESS suresh : http://svn.apache.org/viewcvs.cgi/?root=Apache-SVN&view=rev&rev=1443710 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/fs/FileContext.java
        Hide
        hudson Hudson added a comment -

        Integrated in Hadoop-Yarn-trunk #121 (See https://builds.apache.org/job/Hadoop-Yarn-trunk/121/)
        HADOOP-9277. Improve javadoc for FileContext. Contributed by Andrew Wang. (Revision 1443710)

        Result = SUCCESS
        suresh : http://svn.apache.org/viewcvs.cgi/?root=Apache-SVN&view=rev&rev=1443710
        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/fs/FileContext.java
        Show
        hudson Hudson added a comment - Integrated in Hadoop-Yarn-trunk #121 (See https://builds.apache.org/job/Hadoop-Yarn-trunk/121/ ) HADOOP-9277 . Improve javadoc for FileContext. Contributed by Andrew Wang. (Revision 1443710) Result = SUCCESS suresh : http://svn.apache.org/viewcvs.cgi/?root=Apache-SVN&view=rev&rev=1443710 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/fs/FileContext.java
        Hide
        hudson Hudson added a comment -

        Integrated in Hadoop-Hdfs-trunk #1310 (See https://builds.apache.org/job/Hadoop-Hdfs-trunk/1310/)
        HADOOP-9277. Improve javadoc for FileContext. Contributed by Andrew Wang. (Revision 1443710)

        Result = FAILURE
        suresh : http://svn.apache.org/viewcvs.cgi/?root=Apache-SVN&view=rev&rev=1443710
        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/fs/FileContext.java
        Show
        hudson Hudson added a comment - Integrated in Hadoop-Hdfs-trunk #1310 (See https://builds.apache.org/job/Hadoop-Hdfs-trunk/1310/ ) HADOOP-9277 . Improve javadoc for FileContext. Contributed by Andrew Wang. (Revision 1443710) Result = FAILURE suresh : http://svn.apache.org/viewcvs.cgi/?root=Apache-SVN&view=rev&rev=1443710 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/fs/FileContext.java
        Hide
        hudson Hudson added a comment -

        Integrated in Hadoop-Mapreduce-trunk #1338 (See https://builds.apache.org/job/Hadoop-Mapreduce-trunk/1338/)
        HADOOP-9277. Improve javadoc for FileContext. Contributed by Andrew Wang. (Revision 1443710)

        Result = FAILURE
        suresh : http://svn.apache.org/viewcvs.cgi/?root=Apache-SVN&view=rev&rev=1443710
        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/fs/FileContext.java
        Show
        hudson Hudson added a comment - Integrated in Hadoop-Mapreduce-trunk #1338 (See https://builds.apache.org/job/Hadoop-Mapreduce-trunk/1338/ ) HADOOP-9277 . Improve javadoc for FileContext. Contributed by Andrew Wang. (Revision 1443710) Result = FAILURE suresh : http://svn.apache.org/viewcvs.cgi/?root=Apache-SVN&view=rev&rev=1443710 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/fs/FileContext.java

          People

          • Assignee:
            andrew.wang Andrew Wang
            Reporter:
            andrew.wang Andrew Wang
          • Votes:
            0 Vote for this issue
            Watchers:
            5 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development