Uploaded image for project: 'JDK'
  1. JDK
  2. JDK-4625883

Message says "error" when it's really a warning for missing package-list

    XMLWordPrintable

    Details

    • Subcomponent:
    • Resolved In Build:
      b28
    • CPU:
      generic
    • OS:
      generic

      Description

      Name: rmT116609 Date: 01/18/2002


      java version "1.4.0-beta3"
      Java(TM) 2 Runtime Environment, Standard Edition (build 1.4.0-beta3-b84)
      Java HotSpot(TM) Client VM (build 1.4.0-beta3-b84, mixed mode)

      DESCRIPTION OF THE PROBLEM :
      If a package-list file is missing when the -link option is specified to the javadoc tool, javadoc continutes to operate correctly, but reports that there was an "error" whilst processing the source code.

      The documentation says that it reports a "warning".

      I associate "error" with "something was wrong, could not complete operation" and "warning" with "something was wrong, but we finished it anyway"

      The string constant "error" in the javadoc tool's source should be changed to "warning" for this particular condition.

      STEPS TO FOLLOW TO REPRODUCE THE PROBLEM :
      1. To replicate use any class file, such as:
       
      public class Test
      {
      }


      2. ensure that there is no package-list file in a particular directory:

      rm /tmp/package-list


      3. Try to javadoc that file


      javadoc -link /tmp Test.java
      Loading source file Test.java...
      Constructing Javadoc information...
      javadoc: Error reading file: /tmp/package-list
      Standard Doclet version 1.4.0

      Generating constant-values.html...
      Building tree for all the packages and classes...
      Building index for all the packages and classes...
      Generating overview-tree.html...
      Generating index-all.html...
      Generating deprecated-list.html...
      Building index for all classes...
      Generating allclasses-frame.html...
      Generating allclasses-noframe.html...
      Generating index.html...
      Generating packages.html...
      Generating Test.html...
      Generating package-list...
      Generating help-doc.html...
      Generating stylesheet.css...
      1 error


      EXPECTED VERSUS ACTUAL BEHAVIOR :
      The result is the docs are generated, but the message "1 error" is printed,
      and another message saying something like " Error reading file
      /tmp/package-list"

      In both cases I'd expect it to say "warning"

      This bug can be reproduced always.

      CUSTOMER WORKAROUND :
      When javadoc succeeds, mentally subtract one from the error count, and
      add one to the warning count, if you see a message about a missing package-
      list!!
      (Review ID: 138457)
      ======================================================================

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              jhosunw Jamie Ho (Inactive)
              Reporter:
              rmandalasunw Ranjith Mandala (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:
                Imported:
                Indexed: