Skip to content

Fix incremental build losing output under excludedocfilessubdir - #1346

Open
delanym wants to merge 1 commit into
apache:masterfrom
delanym:mjavadoc-stale-data-excludedocfilessubdir
Open

Fix incremental build losing output under excludedocfilessubdir#1346
delanym wants to merge 1 commit into
apache:masterfrom
delanym:mjavadoc-stale-data-excludedocfilessubdir

Conversation

@delanym

@delanym delanym commented Jul 21, 2026

Copy link
Copy Markdown

When docfilessubdirs is enabled together with excludedocfilessubdir, an incremental build (re-run without a clean) could leave the excluded subdirectory's generated files missing from the output.

copyAllResources() removes the excluded doc-file subdirectories from the output directory before Javadoc runs, relying on Javadoc to regenerate them. However, the staleDataPath up-to-date check (enabled by default) skips the Javadoc invocation when the command line is unchanged, so on a second run the files were deleted but never regenerated.

Move the copyAllResources() call so it runs only when Javadoc is actually (re)generated. When the output is up to date, generation and resource copying are both skipped and the previous output is left intact.

Following this checklist to help us incorporate your
contribution quickly and easily:

  • Your pull request should address just one issue, without pulling in other changes.
  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • Each commit in the pull request should have a meaningful subject line and body.
    Note that commits might be squashed by a maintainer on merge.
  • Write unit tests that match behavioral changes, where the tests fail if the changes to the runtime are not applied.
    This may not always be possible but is a best-practice.
  • Run mvn verify to make sure basic checks pass.
    A more thorough check will be performed on your pull request automatically.
  • You have run the integration tests successfully (mvn -Prun-its verify).

If your pull request is about ~20 lines of code you don't need to sign an
Individual Contributor License Agreement if you are unsure
please ask on the developers list.

To make clear that you license your contribution under
the Apache License Version 2.0, January 2004
you have to acknowledge this by using the following check-box.

When docfilessubdirs is enabled together with excludedocfilessubdir, an
incremental build (re-run without a clean) could leave the excluded
subdirectory's generated files missing from the output.

copyAllResources() removes the excluded doc-file subdirectories from the
output directory before Javadoc runs, relying on Javadoc to regenerate
them. However, the staleDataPath up-to-date check (enabled by default)
skips the Javadoc invocation when the command line is unchanged, so on a
second run the files were deleted but never regenerated.

Move the copyAllResources() call so it runs only when Javadoc is actually
(re)generated. When the output is up to date, generation and resource
copying are both skipped and the previous output is left intact.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant