On Mon, 22 Feb 2021 11:45:21 GMT, Pavel Rappo <[email protected]> wrote:
>> The standard doclet works by creating `HtmlDocument` objects and then
>> writing them out. Writing them can be safely done on a separate thread, and
>> doing so results in about an 8% speedup, by overlapping the write/IO time
>> with the time to generate the next page to be written.
>>
>> The overall impact on the codebase is deliberately small, coming down to a
>> critical `if` statement in `HtmlDocletWriter` to "write now" or "write
>> later". As such, it is easy to disable the feature if necessary, although no
>> issues have been found in practice. The background writer uses an
>> `ExecutorService`, which provides a lot of flexibility, but experiments show
>> that it is sufficient to use a single background thread and to block if new
>> tasks come available while writing a file.
>>
>> The feature is "default on", with a hidden option to disable it if necessary.
>
> src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/HtmlOptions.java
> line 718:
>
>> 716: * Set by command-lione option {@code --background-writer}.
>> 717: */
>> 718: public boolean isBackgroundWriterVerbose() {
>
> Repeated typo "command-lione".
I've moved option handling into `BackgroundWriter`.
-------------
PR: https://git.openjdk.java.net/jdk/pull/2665
