This is an automated email from the ASF dual-hosted git repository.
reschke pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/jackrabbit-oak.git
The following commit(s) were added to refs/heads/trunk by this push:
new 4c2cac63ee OAK-10500: document javadoc build workaround
4c2cac63ee is described below
commit 4c2cac63eef3d9b538c8b855729f02b2090760a8
Author: Julian Reschke <resc...@apache.org>
AuthorDate: Thu Dec 7 12:29:39 2023 +0100
OAK-10500: document javadoc build workaround
---
oak-doc/README.md | 8 ++++++--
1 file changed, 6 insertions(+), 2 deletions(-)
diff --git a/oak-doc/README.md b/oak-doc/README.md
index 5d2bb3f16e..1d4f148717 100644
--- a/oak-doc/README.md
+++ b/oak-doc/README.md
@@ -33,15 +33,19 @@ to clean any existing site,
to build the site **without** Javadoc, and optionally
- mvn site -Pjavadoc
+ mvn site -Pjavadoc -pl
'!oak-shaded-guava,!oak-upgrade,!oak-benchmarks,!oak-search-elastic,!oak-benchmarks-lucene,!oak-benchmarks-solr,!oak-benchmarks-elastic,!oak-run-elastic'
to add Javadoc.
- mvn site -Pdoc,javadoc
+ mvn site -Pdoc,javadoc -pl
'!oak-shaded-guava,!oak-upgrade,!oak-benchmarks,!oak-search-elastic,!oak-benchmarks-lucene,!oak-benchmarks-solr,!oak-benchmarks-elastic,!oak-run-elastic'
to generate **both** site and javadocs. Review the site at
`oak-doc/target/site`.
+(Note that the module exclusions for the javadoc build are needed because
+we have conflicting versions of dependencies, but are trying to build
+"aggregate" API docs; see OAK-10500 for more details.)
+
Then deploy the site to `http://jackrabbit.apache.org/oak/docs/` using
mvn site-deploy -Pdoc
