RFR: 8340818: Add a new jtreg test root to test the generated documentation [v11]

[Nizar Benalla]

On Fri, 18 Oct 2024 08:39:49 GMT, Nizar Benalla <nbenalla at openjdk.org> wrote:

>> Please review this change that adds a new test root `docs` dedicated to testing the documentation, which has been a work in progress for a while. Tests for links, encoding, HTML, accessibility will be later added in following PRs. 
>> 
>> We also define a new make target `test-docs` meant for local use and depends on the docs.
>> This also adds the necessary configurations needed at Oracle.
>> 
>> This patch includes a test `TestDocs` which serves to show developers how they are meant to resolve the docs to test them, I want to include it temporarily until better tests are added later.
>> 
>> TIA
>
> Nizar Benalla has updated the pull request incrementally with one additional commit since the last revision:
> 
>   use existing DOCS_JDK_IMAGE_DIR to be consistent.
>   
>   no ifneq check before assigning the env variable because  DOCS_JDK_IMAGE_DIR is set even docs do not exist. It will be up to the test to check if the files are there

make/RunTests.gmk line 872:

> 870:   $1_JTREG_BASIC_OPTIONS += -e:TEST_IMAGE_DIR=$(TEST_IMAGE_DIR)
> 871: 
> 872:   $1_JTREG_BASIC_OPTIONS += -e:DOCS_JDK_IMAGE_DIR=$$(DOCS_JDK_IMAGE_DIR)

I didn't include a null check here as `DOCS_JDK_IMAGE_DIR` will always hold a value (e.g `build/.../images/docs`) even if the docs don't actually exist. I will be up to the tests to skip when docs aren't found.

-------------

PR Review Comment: https://git.openjdk.org/jdk/pull/21272#discussion_r1806167481