Details

    • Type: Sub-task Sub-task
    • Status: Closed
    • Priority: Blocker Blocker
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 0.21.0
    • Component/s: documentation
    • Labels:
      None
    • Hadoop Flags:
      Reviewed

      Description

      There are a couple of problems with the current Javadoc:

      • The main MapReduce package documentation on the index page appears under "Other Packages" below the fold.
      • Some contrib classes and packages are interspersed in the main MapReduce documentation, which is very confusing for users.
      1. MAPREDUCE-1625.patch
        4 kB
        Tom White
      2. MAPREDUCE-1625.patch
        4 kB
        Tom White
      3. MAPREDUCE-1625.patch
        4 kB
        Tom White

        Activity

        Tom White created issue -
        Hide
        Tom White added a comment -

        Here's a patch which fixes these two problems.

        Unfortunately Javadoc groups can't be used for contrib modules that have classes in the same packages as core MapReduce (e.g. Mumak which includes classes in o.a.h.mapred), since they are specified on a package basis, rather than a source directory basis. For this reason I have removed these contrib classes from the user Javadoc, but I've left them in the "developer Javadoc" which is generated using the "javadoc-dev" target. This only affected Mumak.

        In the long run we can fix this by re-packaging the contrib modules that do this (in addition to Mumak, this includes the scheduler implementations) and use the InterfaceAudience annotation appropriately. (Related to MAPREDUCE-561.)

        There are some contrib modules which should have their user Javadoc published. I have opened MAPREDUCE-1626 to address this problem, since there are lots of warnings that need fixing in doing this.

        Show
        Tom White added a comment - Here's a patch which fixes these two problems. Unfortunately Javadoc groups can't be used for contrib modules that have classes in the same packages as core MapReduce (e.g. Mumak which includes classes in o.a.h.mapred), since they are specified on a package basis, rather than a source directory basis. For this reason I have removed these contrib classes from the user Javadoc, but I've left them in the "developer Javadoc" which is generated using the "javadoc-dev" target. This only affected Mumak. In the long run we can fix this by re-packaging the contrib modules that do this (in addition to Mumak, this includes the scheduler implementations) and use the InterfaceAudience annotation appropriately. (Related to MAPREDUCE-561 .) There are some contrib modules which should have their user Javadoc published. I have opened MAPREDUCE-1626 to address this problem, since there are lots of warnings that need fixing in doing this.
        Tom White made changes -
        Field Original Value New Value
        Attachment MAPREDUCE-1625.patch [ 12439685 ]
        Tom White made changes -
        Status Open [ 1 ] Patch Available [ 10002 ]
        Hide
        Hadoop QA added a comment -

        -1 overall. Here are the results of testing the latest attachment
        http://issues.apache.org/jira/secure/attachment/12439685/MAPREDUCE-1625.patch
        against trunk revision 926449.

        +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 warnings.

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

        -1 core tests. The patch failed core unit tests.

        -1 contrib tests. The patch failed contrib unit tests.

        Test results: http://hudson.zones.apache.org/hudson/job/Mapreduce-Patch-h3.grid.sp2.yahoo.net/351/testReport/
        Findbugs warnings: http://hudson.zones.apache.org/hudson/job/Mapreduce-Patch-h3.grid.sp2.yahoo.net/351/artifact/trunk/build/test/findbugs/newPatchFindbugsWarnings.html
        Checkstyle results: http://hudson.zones.apache.org/hudson/job/Mapreduce-Patch-h3.grid.sp2.yahoo.net/351/artifact/trunk/build/test/checkstyle-errors.html
        Console output: http://hudson.zones.apache.org/hudson/job/Mapreduce-Patch-h3.grid.sp2.yahoo.net/351/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/12439685/MAPREDUCE-1625.patch against trunk revision 926449. +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 warnings. +1 release audit. The applied patch does not increase the total number of release audit warnings. -1 core tests. The patch failed core unit tests. -1 contrib tests. The patch failed contrib unit tests. Test results: http://hudson.zones.apache.org/hudson/job/Mapreduce-Patch-h3.grid.sp2.yahoo.net/351/testReport/ Findbugs warnings: http://hudson.zones.apache.org/hudson/job/Mapreduce-Patch-h3.grid.sp2.yahoo.net/351/artifact/trunk/build/test/findbugs/newPatchFindbugsWarnings.html Checkstyle results: http://hudson.zones.apache.org/hudson/job/Mapreduce-Patch-h3.grid.sp2.yahoo.net/351/artifact/trunk/build/test/checkstyle-errors.html Console output: http://hudson.zones.apache.org/hudson/job/Mapreduce-Patch-h3.grid.sp2.yahoo.net/351/console This message is automatically generated.
        Hide
        Tom White added a comment -

        Test failures are unrelated.

        Show
        Tom White added a comment - Test failures are unrelated.
        Hide
        Tom White added a comment -

        Updated patch that puts lib packages into their own group.

        Show
        Tom White added a comment - Updated patch that puts lib packages into their own group.
        Tom White made changes -
        Attachment MAPREDUCE-1625.patch [ 12440291 ]
        Tom White made changes -
        Status Patch Available [ 10002 ] Open [ 1 ]
        Tom White made changes -
        Status Open [ 1 ] Patch Available [ 10002 ]
        Hide
        Hadoop QA added a comment -

        -1 overall. Here are the results of testing the latest attachment
        http://issues.apache.org/jira/secure/attachment/12440291/MAPREDUCE-1625.patch
        against trunk revision 928104.

        +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 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 contrib tests. The patch failed contrib unit tests.

        Test results: http://hudson.zones.apache.org/hudson/job/Mapreduce-Patch-h4.grid.sp2.yahoo.net/74/testReport/
        Findbugs warnings: http://hudson.zones.apache.org/hudson/job/Mapreduce-Patch-h4.grid.sp2.yahoo.net/74/artifact/trunk/build/test/findbugs/newPatchFindbugsWarnings.html
        Checkstyle results: http://hudson.zones.apache.org/hudson/job/Mapreduce-Patch-h4.grid.sp2.yahoo.net/74/artifact/trunk/build/test/checkstyle-errors.html
        Console output: http://hudson.zones.apache.org/hudson/job/Mapreduce-Patch-h4.grid.sp2.yahoo.net/74/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/12440291/MAPREDUCE-1625.patch against trunk revision 928104. +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 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 contrib tests. The patch failed contrib unit tests. Test results: http://hudson.zones.apache.org/hudson/job/Mapreduce-Patch-h4.grid.sp2.yahoo.net/74/testReport/ Findbugs warnings: http://hudson.zones.apache.org/hudson/job/Mapreduce-Patch-h4.grid.sp2.yahoo.net/74/artifact/trunk/build/test/findbugs/newPatchFindbugsWarnings.html Checkstyle results: http://hudson.zones.apache.org/hudson/job/Mapreduce-Patch-h4.grid.sp2.yahoo.net/74/artifact/trunk/build/test/checkstyle-errors.html Console output: http://hudson.zones.apache.org/hudson/job/Mapreduce-Patch-h4.grid.sp2.yahoo.net/74/console This message is automatically generated.
        Tom White made changes -
        Parent MAPREDUCE-1681 [ 12461344 ]
        Issue Type Improvement [ 4 ] Sub-task [ 7 ]
        Tom White made changes -
        Fix Version/s 0.21.0 [ 12314045 ]
        Priority Major [ 3 ] Blocker [ 1 ]
        Hide
        Tom White added a comment -

        The patch went stale. Here's a new one for trunk.

        Show
        Tom White added a comment - The patch went stale. Here's a new one for trunk.
        Tom White made changes -
        Attachment MAPREDUCE-1625.patch [ 12442878 ]
        Tom White made changes -
        Status Patch Available [ 10002 ] Open [ 1 ]
        Tom White made changes -
        Status Open [ 1 ] Patch Available [ 10002 ]
        Hide
        Chris Douglas added a comment -

        +1

        Show
        Chris Douglas added a comment - +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/12442878/MAPREDUCE-1625.patch
        against trunk revision 938138.

        +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 warnings.

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

        -1 core tests. The patch failed core unit tests.

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

        Test results: http://hudson.zones.apache.org/hudson/job/Mapreduce-Patch-h4.grid.sp2.yahoo.net/141/testReport/
        Findbugs warnings: http://hudson.zones.apache.org/hudson/job/Mapreduce-Patch-h4.grid.sp2.yahoo.net/141/artifact/trunk/build/test/findbugs/newPatchFindbugsWarnings.html
        Checkstyle results: http://hudson.zones.apache.org/hudson/job/Mapreduce-Patch-h4.grid.sp2.yahoo.net/141/artifact/trunk/build/test/checkstyle-errors.html
        Console output: http://hudson.zones.apache.org/hudson/job/Mapreduce-Patch-h4.grid.sp2.yahoo.net/141/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/12442878/MAPREDUCE-1625.patch against trunk revision 938138. +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 warnings. +1 release audit. The applied patch does not increase the total number of release audit warnings. -1 core tests. The patch failed core unit tests. +1 contrib tests. The patch passed contrib unit tests. Test results: http://hudson.zones.apache.org/hudson/job/Mapreduce-Patch-h4.grid.sp2.yahoo.net/141/testReport/ Findbugs warnings: http://hudson.zones.apache.org/hudson/job/Mapreduce-Patch-h4.grid.sp2.yahoo.net/141/artifact/trunk/build/test/findbugs/newPatchFindbugsWarnings.html Checkstyle results: http://hudson.zones.apache.org/hudson/job/Mapreduce-Patch-h4.grid.sp2.yahoo.net/141/artifact/trunk/build/test/checkstyle-errors.html Console output: http://hudson.zones.apache.org/hudson/job/Mapreduce-Patch-h4.grid.sp2.yahoo.net/141/console This message is automatically generated.
        Hide
        Tom White added a comment -

        Test failure is unrelated to the patch.

        Show
        Tom White added a comment - Test failure is unrelated to the patch.
        Hide
        Tom White added a comment -

        I've just committed this.

        Show
        Tom White added a comment - I've just committed this.
        Tom White made changes -
        Status Patch Available [ 10002 ] Resolved [ 5 ]
        Hadoop Flags [Reviewed]
        Resolution Fixed [ 1 ]
        Tom White made changes -
        Status Resolved [ 5 ] Closed [ 6 ]

          People

          • Assignee:
            Tom White
            Reporter:
            Tom White
          • Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development