Project

General

Profile

Bug #8119

JavaDoc build task produces more warnings in Windows in comparison to Linux

Added by Galya B 5 months ago. Updated 5 months ago.

Status:
Closed
Priority:
Normal
Assignee:
Target version:
-
Start date:
Due date:
% Done:

100%

billable:
No
vendor_id:
GCD
case_num:
version:

trunk-r14864-linux-javadoc.log Magnifier (3.55 KB) Galya B, 12/13/2023 09:17 AM

trunk-r14864-win-javadoc.log Magnifier (1.31 MB) Galya B, 12/13/2023 09:17 AM

trunk-r14864-linux-javadoc-xdoclint-all.log Magnifier (1.35 MB) Galya B, 12/14/2023 02:09 AM

ant-javadoc.diff Magnifier (797 Bytes) Galya B, 12/14/2023 02:12 AM

14875.diff Magnifier (1.88 KB) Galya B, 12/14/2023 10:30 AM

History

#1 Updated by Galya B 5 months ago

./gradlew ant-javadoc build task produces more warnings in Windows in comparison to Linux.

#2 Updated by Greg Shah 5 months ago

Could you be building on Windows using the Oracle JDK? The Oracle JDK generates a ver long list of javadoc errors as compared with OpenJDK.

#3 Updated by Galya B 5 months ago

Yes, it's Oracle. This explains it.

But the Oracle ones are valid issues. Can we somehow make Open JDK show them, or this is a door we don't want to open?

#4 Updated by Greg Shah 5 months ago

I don't know of a way to make OpenJDK show them. I'd be glad to see them (as long as it was optional) because to find these now we have to run Oracle JDK which is extra work.

Anyway, our policy is to fix these as we go along but only to require the ones that show in OpenJDK. We'd like to get this 100% clean someday but it is not the highest priority since we have no customers that actually use the Oracle JDK.

#5 Updated by Galya B 5 months ago

Here it is: The same output with -Xdoclint:all. So do we want to open the Pandora box?

#6 Updated by Greg Shah 5 months ago

So do we want to open the Pandora box?

No, but I do want to have a -D option that we can use to enable it. Maybe we add something like -Dverbose_javadoc_errors=true.

#7 Updated by Galya B 5 months ago

Once upon a time I got a project with configured linter that wasn't used. I enabled a test plan in the CI/CD for each feature branch. If a file was updated, the linter ran for it. The failed branch couldn't be merged before the issues were resolved. You can't imagine how quickly the project got back on track. I would love to see FWD with linter in CI/CD. Then Constantin will not have to mention ant-javadoc to me in every code review, while other reviewers are sneaking in new issues.

Back to reality: I'll have to look into how to pass in -D options down to ant.

#8 Updated by Greg Shah 5 months ago

ant automatically picks up any -D options on the command line and turns them into properties that can be referenced in the .xml script.

#9 Updated by Galya B 5 months ago

  • File 14875.diffMagnifier added
  • % Done changed from 0 to 100
  • Assignee set to Galya B
  • Status changed from New to WIP

8119a r14874,14875: Option added to javadoc task to show all warnings.

#10 Updated by Galya B 5 months ago

  • Status changed from WIP to Review

#11 Updated by Greg Shah 5 months ago

  • Status changed from Review to Merge Pending

Code Review Task Branch 8119a Revisions 14874 and 14875

The changes are good.

Please rebase and we will schedule the merge.

#12 Updated by Galya B 5 months ago

Greg Shah wrote:

Code Review Task Branch 8119a Revisions 14874 and 14875

The changes are good.

Please rebase and we will schedule the merge.

8119a rebased on trunk r14906.

#13 Updated by Greg Shah 5 months ago

You can merge now.

#14 Updated by Galya B 5 months ago

  • Status changed from Merge Pending to Test

8119a was merged to trunk as rev. 14907 and archived.

#15 Updated by Greg Shah 5 months ago

Please add this new property to Build Properties.

#16 Updated by Galya B 5 months ago

New param javadoc.verbose added to Building_FWD_From_Source.

#17 Updated by Greg Shah 5 months ago

  • Status changed from Test to Closed

Also available in: Atom PDF