Uploaded image for project: 'Maven Javadoc Plugin'
  1. Maven Javadoc Plugin
  2. MJAVADOC-626

Detect stale files and skip generation if not needed

    XMLWordPrintableJSON

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: 3.1.1
    • Fix Version/s: 3.2.0
    • Component/s: javadoc
    • Labels:
      None

      Description

      In Apache Camel, we do use javadoc during the build as we have a few things that are generated from the javadoc.  However, javadoc can take quite some time to build, so I came up with a stale file/config detection mechanism in order to avoid recomputing the javadoc if there is no change.

       

      The idea is to compute an input state consisting of all the command line options (flattening the @xxx options) and the list of all input files along with their last modification date.  Before actually executing the command line, we compare the current state with the last saved state and skip the execution if there is no change.

      The code is visible in this commit mainly: https://github.com/apache/camel/pull/3233/commits/57903a94f82413022afc594e374fb3dff4f7578a and if there is an agreement, I can create a correct PR to incorporate the change.

       

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                olamy Olivier Lamy
                Reporter:
                gnodet Guillaume Nodet
              • Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Time Tracking

                  Estimated:
                  Original Estimate - Not Specified
                  Not Specified
                  Remaining:
                  Remaining Estimate - 0h
                  0h
                  Logged:
                  Time Spent - 20m
                  20m