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

JEP 212: Resolve Lint and Doclint Warnings

    Details

    • Author:
      Joseph D. Darcy
    • JEP Type:
      Feature
    • Exposure:
      Open
    • Scope:
      JDK
    • Discussion:
      jdk9 dash dev at openjdk dot java dot net
    • Effort:
      M
    • Duration:
      L
    • Alert Status:
       Green
    • JEP Number:
      212

      Description

      Summary

      The JDK code base contains numerous lint and doclint errors as reported by javac. These warnings should be resolved, at least for the fundamental parts of the platform.

      Goals

      Operationally, the goal is to have at least the packages for the fundamental packages in the platform (those discussed on core-libs, awt-dev, swing-dev, 2d-dev, etc.) compile cleanly under javac's lint and doclint warnings. It is desirable for other packages, such as those comprising JAXP, JAX-WS, and CORBA to also compile cleanly with all warnings enabled.

      Success Metrics

      A successful build of the sources in question when the -Xlint:all option is used for the javac command. A slightly weaker goal that may be acceptable is for all the source-related lint options to be enabled, but not the lint options for non-source properties. For example, some lint options concern properties of the javac command line rather than the sources being compiled.

      Description

      This JEP proposes to complete efforts to fix warnings that have been underway in JDK 8 and JDK 9 as well as to formalize a subset of source-code improvements previously proposed to jdk9-dev. Most of the warnings are resolved by modifying the interior of method bodies. Resolving some of rawtypes warnings involves changing method signatures, such as changing a parameter type from a raw java.lang.Class to a java.lang.Class<?> or some more specific type. Any API changes will stay within the general evolution policy of the JDK.

      Testing

      A successful compile / build is the primary test for most changes, but the existing regression tests should continue to pass. Where a Java SE API has a signature change, the corresponding JCK signature test will need to be updated accordingly.

      Dependences

      Resolving the deprecation warnings in the JDK would be eased if importing a deprecated type does not trigger a deprecation warning.

        Issue Links

          Activity

          Hide
          ggalimbe Gustavo Galimberti added a comment -
          Jibing is driving a get-well plan with the client component as that's where this initiative is currently behind.
          This get-well plan is undergoing discussion as we speak.
          Show
          ggalimbe Gustavo Galimberti added a comment - Jibing is driving a get-well plan with the client component as that's where this initiative is currently behind. This get-well plan is undergoing discussion as we speak.
          Hide
          jibiche Jibing Chen (Inactive) added a comment -
          Sandeep/Jibing are coordinating SQE resource on fixing the docline warnings in Client side. We will come out a new plan in the beginning of next week (Mar. 3rd)
          Show
          jibiche Jibing Chen (Inactive) added a comment - Sandeep/Jibing are coordinating SQE resource on fixing the docline warnings in Client side. We will come out a new plan in the beginning of next week (Mar. 3rd)
          Hide
          darcy Joe Darcy added a comment -
          With the push of the fix for JDK-8080722, all the doclint checks are now enabled in the build. The doclint checks were previously enabled. As both kinds of checks are now enabled over the necessary sets of types, this JEP is now complete.
          Show
          darcy Joe Darcy added a comment - With the push of the fix for JDK-8080722 , all the doclint checks are now enabled in the build. The doclint checks were previously enabled. As both kinds of checks are now enabled over the necessary sets of types, this JEP is now complete.

            People

            • Assignee:
              darcy Joe Darcy
              Reporter:
              darcy Joe Darcy
              Owner:
              Joe Darcy
              Reviewed By:
              Brian Goetz
              Endorsed By:
              Brian Goetz
            • Votes:
              0 Vote for this issue
              Watchers:
              9 Start watching this issue

              Dates

              • Due:
                Created:
                Updated:
                Resolved:
                Integration Due: