Details

    • Type: Task Task
    • Status: Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: None
    • Labels:
      None

      Activity

      Maria Odea Ching created issue -
      Maria Odea Ching made changes -
      Field Original Value New Value
      Status Open [ 1 ] In Progress [ 3 ]
      Maria Odea Ching made changes -
      Due Date 2006-07-21 00:00:00.0 2006-07-24 00:00:00.0
      Maria Odea Ching logged work - 19/Jul/06 06:16
      • Time Spent:
        3h
         
        Reviewed plugin and the plugin docs.
      Maria Odea Ching made changes -
      Time Spent 3h [ 10800 ]
      Remaining Estimate 22h [ 79200 ] 19h [ 68400 ]
      Maria Odea Ching logged work - 20/Jul/06 06:54
      • Time Spent:
        6h
         
        - Review codes and existing plugin docs
        - Started with index.apt
      Maria Odea Ching made changes -
      Remaining Estimate 19h [ 68400 ] 13h [ 46800 ]
      Time Spent 3h [ 10800 ] 9h [ 32400 ]
      Maria Odea Ching logged work - 21/Jul/06 06:15
      • Time Spent:
        7h
         
        Examples apt
      Maria Odea Ching made changes -
      Time Spent 9h [ 32400 ] 16h [ 57600 ]
      Remaining Estimate 13h [ 46800 ] 6h [ 21600 ]
      Maria Odea Ching logged work - 24/Jul/06 06:53
      • Time Spent:
        6h
         
        Finished examples. Revised index.apt.
      Maria Odea Ching made changes -
      Time Spent 16h [ 57600 ] 22h [ 79200 ]
      Remaining Estimate 6h [ 21600 ] 0h [ 0 ]
      Hide
      Dennis Lundberg added a comment -

      Fixed a couple of minor typos and changed "checkstyle" to "Checkstyle" in a number of places.

      Show
      Dennis Lundberg added a comment - Fixed a couple of minor typos and changed "checkstyle" to "Checkstyle" in a number of places.
      Dennis Lundberg made changes -
      Attachment documentation.patch [ 21767 ]
      Maria Odea Ching made changes -
      Status In Progress [ 3 ] Open [ 1 ]
      Hide
      Maria Odea Ching added a comment -

      Review comments by Vincent Siveton (from Maven Dev List):

      ------
      here my comments:

      usage.html
      Should be better to create two subsections:

      • Generate the report as part of Project Reports
      • Generate the report as standalone

      Maybe add a report screenshot

      FAQ
      "checkstyle.properties" or "checkstyle properties" (with space)
      If the first, the following seems wrong according the doc
      <configLocation>checkstyle.properties</configLocation>
      http://people.apache.org/~oching/maven-checkstyle-plugin/checkstyle-mojo.html#configLocation

      custom-property-expansion.html
      propertiesLocation has no sample. Is is the same explained in FAQ?

      multi-module-config.html
      Review it as said
      Replace unix commands by a directory layout:
      whizbang

      – pom.xml
      `-- src
      – main
      ...

      Cheers,

      Vincent

      Show
      Maria Odea Ching added a comment - Review comments by Vincent Siveton (from Maven Dev List): ------ here my comments: usage.html Should be better to create two subsections: Generate the report as part of Project Reports Generate the report as standalone Maybe add a report screenshot FAQ "checkstyle.properties" or "checkstyle properties" (with space) If the first, the following seems wrong according the doc <configLocation>checkstyle.properties</configLocation> http://people.apache.org/~oching/maven-checkstyle-plugin/checkstyle-mojo.html#configLocation custom-property-expansion.html propertiesLocation has no sample. Is is the same explained in FAQ? multi-module-config.html Review it as said Replace unix commands by a directory layout: whizbang – pom.xml `-- src – main ... Cheers, Vincent
      Hide
      Maria Odea Ching added a comment -

      Review comments by Stephen Duncan (from Maven Dev List):


      On the "Multimodule Configuration" documentation:

      As I just mentioned on a question on the user's list, I don't think
      it's correct to specify the "build-tools" dependency as a dependency
      of the plugin. While this will work if you manually install the
      build-tools jar, it will not download it from an internal repository.
      It should instead be specified as build extension like in the "Using
      Custom Developed Chechstyle Check Modules" example. (Also not the
      spelling mistake in that title: ChecHstyle).

      Because this is somewhat confusing, I think it should mentioned either
      in the "Using a Custom Checkstyle Checker Configuration" as a way of
      using a classpath reference, or it should be it's own guide on using a
      shared jar for configuration.

      • Stephen
      Show
      Maria Odea Ching added a comment - Review comments by Stephen Duncan (from Maven Dev List): On the "Multimodule Configuration" documentation: As I just mentioned on a question on the user's list, I don't think it's correct to specify the "build-tools" dependency as a dependency of the plugin. While this will work if you manually install the build-tools jar, it will not download it from an internal repository. It should instead be specified as build extension like in the "Using Custom Developed Chechstyle Check Modules" example. (Also not the spelling mistake in that title: ChecHstyle). Because this is somewhat confusing, I think it should mentioned either in the "Using a Custom Checkstyle Checker Configuration" as a way of using a classpath reference, or it should be it's own guide on using a shared jar for configuration. Stephen
      Hide
      Maria Odea Ching added a comment -

      Review comments by Dennis Lundberg (from Maven Dev List):


      +1 to put the it in a guide of its own. I believe that this is a very common thing that companies and large organizations want to do.

      I've attached a path to MCHECKSTYLE-49 with some minor fixes.

      The goal descriptions are not clear to me as they are now. What is the difference between the goals? It sound like they do the same thing. Also their descriptions are not the same on the index page as on the plugin-info page.

      Show
      Maria Odea Ching added a comment - Review comments by Dennis Lundberg (from Maven Dev List): +1 to put the it in a guide of its own. I believe that this is a very common thing that companies and large organizations want to do. I've attached a path to MCHECKSTYLE-49 with some minor fixes. The goal descriptions are not clear to me as they are now. What is the difference between the goals? It sound like they do the same thing. Also their descriptions are not the same on the index page as on the plugin-info page.
      Maria Odea Ching made changes -
      Status Open [ 1 ] In Progress [ 3 ]
      Maria Odea Ching logged work - 25/Jul/06 04:47
      • Time Spent:
        4h
         
        - Revised the docs, and applied some of the comments in the review
      Maria Odea Ching made changes -
      Time Spent 22h [ 79200 ] 26h [ 93600 ]
      Maria Odea Ching made changes -
      Status In Progress [ 3 ] Open [ 1 ]
      Maria Odea Ching made changes -
      Status Open [ 1 ] In Progress [ 3 ]
      Hide
      Maria Odea Ching added a comment -

      I've already revised and applied the review comments in the plugin docs.

      Btw, for the shared jar configuration issue in "Multimodule Configuration", I've just revised the page and mentioned the shared jar configuration issue (declaring it as an extension instead of as a plugin dependency) instead of having a separate guide for that. I did this because I think it would just have almost the same example used in "Multimodule Configuration".

      The staging site (http://people.apache.org/~oching/maven-checkstyle-plugin) has already been updated. Thanks

      Show
      Maria Odea Ching added a comment - I've already revised and applied the review comments in the plugin docs. Btw, for the shared jar configuration issue in "Multimodule Configuration", I've just revised the page and mentioned the shared jar configuration issue (declaring it as an extension instead of as a plugin dependency) instead of having a separate guide for that. I did this because I think it would just have almost the same example used in "Multimodule Configuration". The staging site ( http://people.apache.org/~oching/maven-checkstyle-plugin ) has already been updated. Thanks
      Maria Odea Ching logged work - 26/Jul/06 07:35
      • Time Spent:
        5h
         
        Investigated and revised Multimodule Configuration apt.
      Maria Odea Ching made changes -
      Time Spent 26h [ 93600 ] 31h [ 111600 ]
      Maria Odea Ching made changes -
      Status In Progress [ 3 ] Open [ 1 ]
      Maria Odea Ching made changes -
      Resolution Fixed [ 1 ]
      Status Open [ 1 ] Closed [ 6 ]
      Mark Thomas made changes -
      Project Import Sun Apr 05 09:17:21 UTC 2015 [ 1428225441187 ]
      Mark Thomas made changes -
      Workflow jira [ 12718233 ] Default workflow, editable Closed status [ 12749729 ]
      Mark Thomas made changes -
      Project Import Sun Apr 05 22:43:44 UTC 2015 [ 1428273824526 ]
      Mark Thomas made changes -
      Workflow jira [ 12955816 ] Default workflow, editable Closed status [ 12992912 ]
      Transition Time In Source Status Execution Times Last Executer Last Execution Date
      Open Open In Progress In Progress
      8d 31m 3 Maria Odea Ching 25/Jul/06 21:28
      In Progress In Progress Open Open
      6d 17h 57m 3 Maria Odea Ching 26/Jul/06 21:56
      Open Open Closed Closed
      5d 6h 20m 1 Maria Odea Ching 01/Aug/06 04:16

        People

        • Assignee:
          Maria Odea Ching
          Reporter:
          Maria Odea Ching
        • Votes:
          0 Vote for this issue
          Watchers:
          0 Start watching this issue

          Dates

          • Due:
            Created:
            Updated:
            Resolved:

            Time Tracking

            Estimated:
            Original Estimate - 22h Original Estimate - 22h
            22h
            Remaining:
            Remaining Estimate - 0h
            0h
            Logged:
            Time Spent - 31h
            31h

              Development