Maven 2.x Checkstyle Plugin

Xref link generation regression with Maven 3

Details

  • Type: Bug Bug
  • Status: Open Open
  • Priority: Minor Minor
  • Resolution: Unresolved
  • Affects Version/s: 2.6
  • Fix Version/s: None
  • Labels:
    None
  • Environment:
  • Number of attachments :
    2

Description

When the site reports are created with Maven 3, the Checkstyle plugin doesn't generate the links to the Source Xref pages, when the JXR Plugin hasn't been executed before.

The plugin looks for the xrefLocation directory and if it doesn't exist, it checks if the JXR plugin is configured for the project (see http://maven.apache.org/plugins/maven-checkstyle-plugin/xref/org/apache/maven/plugin/checkstyle/CheckstyleReport.html#670). To properly generate the Xref links when the report is created with Maven 3, the plugin should also check the reportPlugins paramerter of the Site plugin configuration.

Issue Links

is related to

Bug - A problem which impairs or prevents the functions of the product. SUREFIRE-683 Xref link generation regression with Maven 3

  • Minor - Minor loss of function, or other problem where easy workaround is present.
  • Open - The issue is open and ready for the assignee to start work on it.
relates to

Bug - A problem which impairs or prevents the functions of the product. MPMD-128 Xref link generation regression with Maven 3

  • Minor - Minor loss of function, or other problem where easy workaround is present.
  • Open - The issue is open and ready for the assignee to start work on it.

Wish - General wishlist item MCLIRR-38 Xref link generation not working when using the 'reportPlugins' parameter of the site plugin instead of the 'reporting' section of the pom.

  • Minor - Minor loss of function, or other problem where easy workaround is present.
  • Open - The issue is open and ready for the assignee to start work on it.

Wish - General wishlist item JXR-91 Javadoc link generation not working when using the 'reportPlugins' parameter of the site plugin instead of the 'reporting' section of the pom.

  • Minor - Minor loss of function, or other problem where easy workaround is present.
  • Closed - The issue is considered finished, the resolution is correct. Issues which are not closed can be reopened.

Wish - General wishlist item MFINDBUGS-145 Xref link generation not working when using the 'reportPlugins' parameter of the site plugin instead of the 'reporting' section of the pom.

  • Minor - Minor loss of function, or other problem where easy workaround is present.
  • Closed - The issue is considered finished, the resolution is correct. Issues which are not closed can be reopened.

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Marc Rohlfs added a comment -

As there's no reliable order for the report plugin execution, I can't provide a sample that surely demonstrates the problem. To test, You might change the order of the Checkstyle and the JXR plugin in the POM.

Show
Marc Rohlfs added a comment - As there's no reliable order for the report plugin execution, I can't provide a sample that surely demonstrates the problem. To test, You might change the order of the Checkstyle and the JXR plugin in the POM.
Hide
Permalink
Marc Rohlfs added a comment -

As a workaround You could just add a simple JXR Plugin configuration to the reporting section of Your (parent) POM:

<reporting>
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-jxr-plugin</artifactId>
      <version>2.2</version>
    </plugin>
  </plugins>
</reporting>
Show
Marc Rohlfs added a comment - As a workaround You could just add a simple JXR Plugin configuration to the reporting section of Your (parent) POM: <reporting> <plugins> <plugin> <groupId> org.apache.maven.plugins </groupId> <artifactId> maven-jxr-plugin </artifactId> <version> 2.2 </version> </plugin> </plugins> </reporting>
Hide
Permalink
Christian Schulte added a comment -

Patch adding a corresponding integration test.

Show
Christian Schulte added a comment - Patch adding a corresponding integration test.

People

  • Assignee:
    Unassigned
    Reporter:
    Marc Rohlfs
Vote (2)
Watch (2)

Dates

  • Created:
    Updated: