From ac75ce989100589f1f40c2021c33c51cfb6fa5e1 Mon Sep 17 00:00:00 2001 From: Guillaume Smet Date: Tue, 10 Sep 2024 17:29:54 +0200 Subject: [PATCH] Config Doc - Reinstate Reactive Oracle Client doc In the end, let's keep it around but handles it properly in the generated config doc. --- .../io/quarkus/maven/config/doc/GenerateAsciidocMojo.java | 2 +- .../io/quarkus/maven/config/doc/GenerateConfigDocMojo.java | 4 +--- .../templates/asciidoc/default/configReference.qute.adoc | 3 +++ docs/src/main/asciidoc/datasource.adoc | 2 +- docs/src/main/asciidoc/reactive-sql-clients.adoc | 2 +- .../oracle/client/runtime/DataSourceReactiveOracleConfig.java | 1 - 6 files changed, 7 insertions(+), 7 deletions(-) diff --git a/devtools/config-doc-maven-plugin/src/main/java/io/quarkus/maven/config/doc/GenerateAsciidocMojo.java b/devtools/config-doc-maven-plugin/src/main/java/io/quarkus/maven/config/doc/GenerateAsciidocMojo.java index dee67e7ce959f..a1ed3bf1bae0e 100644 --- a/devtools/config-doc-maven-plugin/src/main/java/io/quarkus/maven/config/doc/GenerateAsciidocMojo.java +++ b/devtools/config-doc-maven-plugin/src/main/java/io/quarkus/maven/config/doc/GenerateAsciidocMojo.java @@ -10,4 +10,4 @@ */ @Mojo(name = "generate-asciidoc", defaultPhase = LifecyclePhase.GENERATE_RESOURCES, threadSafe = true) public class GenerateAsciidocMojo extends GenerateConfigDocMojo { -} \ No newline at end of file +} diff --git a/devtools/config-doc-maven-plugin/src/main/java/io/quarkus/maven/config/doc/GenerateConfigDocMojo.java b/devtools/config-doc-maven-plugin/src/main/java/io/quarkus/maven/config/doc/GenerateConfigDocMojo.java index 0530062b329b2..ed5626b9f1bf1 100644 --- a/devtools/config-doc-maven-plugin/src/main/java/io/quarkus/maven/config/doc/GenerateConfigDocMojo.java +++ b/devtools/config-doc-maven-plugin/src/main/java/io/quarkus/maven/config/doc/GenerateConfigDocMojo.java @@ -111,9 +111,7 @@ public void execute() throws MojoExecutionException, MojoFailureException { String topLevelPrefix = configRootEntry.getKey().topLevelPrefix(); ConfigRoot configRoot = configRootEntry.getValue(); - if (configRoot.getNonDeprecatedItems().isEmpty()) { - continue; - } + // here we generate a file even if there are no items as it's used for the Reactive Oracle SQL client configRootPath = resolvedTargetDirectory.resolve(String.format(CONFIG_ROOT_FILE_FORMAT, extension.artifactId(), topLevelPrefix, normalizedFormat.getExtension())); diff --git a/devtools/config-doc-maven-plugin/src/main/resources/templates/asciidoc/default/configReference.qute.adoc b/devtools/config-doc-maven-plugin/src/main/resources/templates/asciidoc/default/configReference.qute.adoc index c694aeaf7a289..c5151982992c2 100644 --- a/devtools/config-doc-maven-plugin/src/main/resources/templates/asciidoc/default/configReference.qute.adoc +++ b/devtools/config-doc-maven-plugin/src/main/resources/templates/asciidoc/default/configReference.qute.adoc @@ -16,6 +16,9 @@ h|Default {#configProperty configProperty=item extension=extension additionalAnchorPrefix=additionalAnchorPrefix /} {/if} +{#else} +3+|No configuration properties found. + {/for} |=== diff --git a/docs/src/main/asciidoc/datasource.adoc b/docs/src/main/asciidoc/datasource.adoc index 4828026f53e22..70cfc46a743fa 100644 --- a/docs/src/main/asciidoc/datasource.adoc +++ b/docs/src/main/asciidoc/datasource.adoc @@ -952,7 +952,7 @@ include::{generated-dir}/config/quarkus-reactive-mssql-client.adoc[opts=optional ==== Reactive Oracle-specific configuration -At the moment, there are no Oracle-specific configuration properties. +include::{generated-dir}/config/quarkus-reactive-oracle-client.adoc[opts=optional, leveloffset=+1] ==== Reactive PostgreSQL-specific configuration diff --git a/docs/src/main/asciidoc/reactive-sql-clients.adoc b/docs/src/main/asciidoc/reactive-sql-clients.adoc index 4ce05554a1b89..5b64977d6a91c 100644 --- a/docs/src/main/asciidoc/reactive-sql-clients.adoc +++ b/docs/src/main/asciidoc/reactive-sql-clients.adoc @@ -922,7 +922,7 @@ include::{generated-dir}/config/quarkus-reactive-mssql-client.adoc[opts=optional === Oracle -At the moment, there are no Oracle-specific configuration properties. +include::{generated-dir}/config/quarkus-reactive-oracle-client.adoc[opts=optional, leveloffset=+1] === PostgreSQL diff --git a/extensions/reactive-oracle-client/runtime/src/main/java/io/quarkus/reactive/oracle/client/runtime/DataSourceReactiveOracleConfig.java b/extensions/reactive-oracle-client/runtime/src/main/java/io/quarkus/reactive/oracle/client/runtime/DataSourceReactiveOracleConfig.java index fd546210e454f..778e30be8ac13 100644 --- a/extensions/reactive-oracle-client/runtime/src/main/java/io/quarkus/reactive/oracle/client/runtime/DataSourceReactiveOracleConfig.java +++ b/extensions/reactive-oracle-client/runtime/src/main/java/io/quarkus/reactive/oracle/client/runtime/DataSourceReactiveOracleConfig.java @@ -5,5 +5,4 @@ @ConfigGroup public interface DataSourceReactiveOracleConfig { - // when adding properties here, make sure you include the generated doc in datasource.adoc and reactive-sql-clients.adoc }