[MJAVADOC-803] Add default parameter to force root locale

• Type: Improvement
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 3.7.0
• Fix Version/s: 3.8.0
• Component/s: jar, javadoc
• Assignee: Michael Osipov
• Reporter: Michael Osipov
• Created: 13/Jul/24 08:07
• Updated: 13/Jul/24 22:01
• Resolved: 13/Jul/24 19:16

Description

Javadoc suffers from the following two problems:

• During HTML generatation Locale#getDefault() is invoked and all generated content maybe localized, e.g. German, Japanese. That is a surprise for most since they expect to see English content. One has to force with <locale>en</locale>.
• In the past JDKs Oracle now started to even localize stdout and stderr output to those languages (see https://github.com/openjdk/jdk21u-dev/tree/master/src/jdk.javadoc/share/classes/jdk/javadoc/internal/tool/resources), even more could come. This causes a regression with MJAVADOC-751 which relies on English language output to work.

Therefore, we will introduce a new parameter forceRootLocale which will add -J-Duser.language= -J-Duser.country= and will result in Locale#ROOT. Both will force generated HTML output and std output to be in English. Those who still need generated content in a specific language can pass <locale/> and it will work independently of the std output.

Issue Links

• fixes: MJAVADOC-751 No warnings for localized output
• links to: GitHub Pull Request #298