Hadoop Common
  1. Hadoop Common
  2. HADOOP-4626

API link in forrest doc should point to the same version of hadoop.

    Details

    • Type: Bug Bug
    • Status: Resolved
    • Priority: Minor Minor
    • Resolution: Fixed
    • Affects Version/s: 0.17.2
    • Fix Version/s: 0.20.1
    • Component/s: documentation
    • Labels:
      None
    • Hadoop Flags:
      Reviewed

      Description

      For example, in http://hadoop.apache.org/core/docs/r0.17.2/hdfs_user_guide.html, the setSafeMode() link is pointing to http ://hadoop.apache.org/core/docs/current/..., which is not an 0.17 doc.

      1. 4626_20090526.patch
        2 kB
        Tsz Wo Nicholas Sze

        Issue Links

          Activity

          Tom White made changes -
          Fix Version/s 0.21.0 [ 12313563 ]
          Tsz Wo Nicholas Sze made changes -
          Status Open [ 1 ] Resolved [ 5 ]
          Fix Version/s 0.20.1 [ 12313866 ]
          Fix Version/s 0.21.0 [ 12313563 ]
          Resolution Fixed [ 1 ]
          Hide
          Tsz Wo Nicholas Sze added a comment -

          I have committed this to 0.20 and above.

          Show
          Tsz Wo Nicholas Sze added a comment - I have committed this to 0.20 and above.
          Ravi Phulari made changes -
          Hadoop Flags [Reviewed]
          Assignee Tsz Wo (Nicholas), SZE [ szetszwo ]
          Hide
          Ravi Phulari added a comment -

          +1
          Generated doc manually and verified for link correctness. Patch looks good.
          Thanks Nicholas.

          Show
          Ravi Phulari added a comment - +1 Generated doc manually and verified for link correctness. Patch looks good. Thanks Nicholas.
          Hide
          Tsz Wo Nicholas Sze added a comment -

          I checked the generated doc manually. The links are correct.

          Show
          Tsz Wo Nicholas Sze added a comment - I checked the generated doc manually. The links are correct.
          Hide
          Tsz Wo Nicholas Sze added a comment -
               [exec] -1 overall.  
               [exec] 
               [exec]     +1 @author.  The patch does not contain any @author tags.
               [exec] 
               [exec]     -1 tests included.  The patch doesn't appear to include any new or modified tests.
               [exec]                         Please justify why no tests are needed for this patch.
               [exec] 
               [exec]     +1 javadoc.  The javadoc tool did not generate any warning messages.
               [exec] 
               [exec]     +1 javac.  The applied patch does not increase the total number of javac compiler warnings.
               [exec] 
               [exec]     +1 findbugs.  The patch does not introduce any new Findbugs warnings.
               [exec] 
               [exec]     +1 Eclipse classpath. The patch retains Eclipse classpath integrity.
               [exec] 
               [exec]     +1 release audit.  The applied patch does not increase the total number of release audit warnings.
          

          This is a documentation change. No sure why "ant test-patch" cannot detect it but -1 on tests included.

          Show
          Tsz Wo Nicholas Sze added a comment - [exec] -1 overall. [exec] [exec] +1 @author. The patch does not contain any @author tags. [exec] [exec] -1 tests included. The patch doesn't appear to include any new or modified tests. [exec] Please justify why no tests are needed for this patch. [exec] [exec] +1 javadoc. The javadoc tool did not generate any warning messages. [exec] [exec] +1 javac. The applied patch does not increase the total number of javac compiler warnings. [exec] [exec] +1 findbugs. The patch does not introduce any new Findbugs warnings. [exec] [exec] +1 Eclipse classpath. The patch retains Eclipse classpath integrity. [exec] [exec] +1 release audit. The applied patch does not increase the total number of release audit warnings. This is a documentation change. No sure why "ant test-patch" cannot detect it but -1 on tests included.
          Tsz Wo Nicholas Sze made changes -
          Attachment 4626_20090526.patch [ 12409090 ]
          Hide
          Tsz Wo Nicholas Sze added a comment -

          4626_20090526.patch: fix API version.

          The setSafeMode() link will be fixed in HADOOP-5918.

          Show
          Tsz Wo Nicholas Sze added a comment - 4626_20090526.patch: fix API version. The setSafeMode() link will be fixed in HADOOP-5918 .
          Tsz Wo Nicholas Sze made changes -
          Field Original Value New Value
          Link This issue is related to HADOOP-5918 [ HADOOP-5918 ]
          Hide
          Tsz Wo Nicholas Sze added a comment - - edited

          The setSafeMode() link indeed is a missing link, instead of a broken link, since the hdfs api docs are not available in the public web site. Similarly, links to HDFS Java API do not exist.

          Show
          Tsz Wo Nicholas Sze added a comment - - edited The setSafeMode() link indeed is a missing link, instead of a broken link, since the hdfs api docs are not available in the public web site. Similarly, links to HDFS Java API do not exist.
          Hide
          Doug Cutting added a comment -

          These should be replaced in the xml source with relative links to api/org/apache/hadoop/...

          Show
          Doug Cutting added a comment - These should be replaced in the xml source with relative links to api/org/apache/hadoop/...
          Tsz Wo Nicholas Sze created issue -

            People

            • Assignee:
              Tsz Wo Nicholas Sze
              Reporter:
              Tsz Wo Nicholas Sze
            • Votes:
              1 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Development