From 723b16864e4e964e965e525d4d49e2eaba1f1677 Mon Sep 17 00:00:00 2001 From: Tran Ngoc Nhan Date: Wed, 16 Oct 2024 23:49:41 +0700 Subject: [PATCH 1/3] Update document --- .../boot/build/antora/antora-asciidoc-attributes.properties | 2 +- .../src/docs/antora/modules/reference/pages/io/caching.adoc | 2 +- .../src/docs/antora/modules/reference/pages/messaging/amqp.adoc | 2 +- .../docs/io/jta/mixingxaandnonxaconnections/nonxa/MyBean.kt | 2 ++ .../docs/io/jta/mixingxaandnonxaconnections/primary/MyBean.kt | 2 ++ .../boot/docs/io/jta/mixingxaandnonxaconnections/xa/MyBean.kt | 2 ++ 6 files changed, 9 insertions(+), 3 deletions(-) diff --git a/buildSrc/src/main/resources/org/springframework/boot/build/antora/antora-asciidoc-attributes.properties b/buildSrc/src/main/resources/org/springframework/boot/build/antora/antora-asciidoc-attributes.properties index 992d303bef70..95ac27dc67fc 100644 --- a/buildSrc/src/main/resources/org/springframework/boot/build/antora/antora-asciidoc-attributes.properties +++ b/buildSrc/src/main/resources/org/springframework/boot/build/antora/antora-asciidoc-attributes.properties @@ -33,7 +33,7 @@ url-native-build-tools-docs-gradle-plugin={url-native-build-tools-docs}/gradle-p url-native-build-tools-docs-maven-plugin={url-native-build-tools-docs}/maven-plugin.html url-paketo-docs=https://paketo.io/docs url-paketo-docs-java-buildpack={url-paketo-docs}/buildpacks/language-family-buildpacks/java -url-spring-boot-for-apache-geode-docs=https://docs.spring.io/spring-boot-data-geode-build/2.0.x/reference/html5 +url-spring-boot-for-apache-geode-docs=https://docs.spring.io/spring-data/geode/docs/current/reference/html/ url-spring-boot-for-apache-geode-site=https://github.com/spring-projects/spring-boot-data-geode url-spring-data-cassandra-javadoc=https://docs.spring.io/spring-data/cassandra/docs/{version-spring-data-cassandra-javadoc}/api url-spring-data-cassandra-site=https://spring.io/projects/spring-data-cassandra diff --git a/spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/io/caching.adoc b/spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/io/caching.adoc index d5c86db19f11..888b5718574c 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/io/caching.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/io/caching.adoc @@ -13,7 +13,7 @@ In a nutshell, to add caching to an operation of your service add the relevant a include-code::MyMathService[] This example demonstrates the use of caching on a potentially costly operation. -Before invoking `computePiDecimal`, the abstraction looks for an entry in the `piDecimals` cache that matches the `i` argument. +Before invoking `computePiDecimal`, the abstraction looks for an entry in the `piDecimals` cache that matches the `precision` argument. If an entry is found, the content in the cache is immediately returned to the caller, and the method is not invoked. Otherwise, the method is invoked, and the cache is updated before returning the value. diff --git a/spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/messaging/amqp.adoc b/spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/messaging/amqp.adoc index 6dd49a01ee36..41de38e042ba 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/messaging/amqp.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/messaging/amqp.adoc @@ -110,7 +110,7 @@ The following sample component creates a listener endpoint on the `someQueue` qu include-code::MyBean[] -TIP: See javadoc:{url-spring-amqp-javadoc}/org.springframework.amqp.rabbit.annotation.EnableRabbit.html[format=annotation] for more details. +TIP: See javadoc:{url-spring-amqp-javadoc}/org.springframework.amqp.rabbit.annotation.EnableRabbit[format=annotation] for more details. If you need to create more `RabbitListenerContainerFactory` instances or if you want to override the default, Spring Boot provides a `SimpleRabbitListenerContainerFactoryConfigurer` and a `DirectRabbitListenerContainerFactoryConfigurer` that you can use to initialize a `SimpleRabbitListenerContainerFactory` and a `DirectRabbitListenerContainerFactory` with the same settings as the factories used by the auto-configuration. diff --git a/spring-boot-project/spring-boot-docs/src/main/kotlin/org/springframework/boot/docs/io/jta/mixingxaandnonxaconnections/nonxa/MyBean.kt b/spring-boot-project/spring-boot-docs/src/main/kotlin/org/springframework/boot/docs/io/jta/mixingxaandnonxaconnections/nonxa/MyBean.kt index 690d857acb1c..33f81cbcc60d 100644 --- a/spring-boot-project/spring-boot-docs/src/main/kotlin/org/springframework/boot/docs/io/jta/mixingxaandnonxaconnections/nonxa/MyBean.kt +++ b/spring-boot-project/spring-boot-docs/src/main/kotlin/org/springframework/boot/docs/io/jta/mixingxaandnonxaconnections/nonxa/MyBean.kt @@ -14,6 +14,7 @@ * limitations under the License. */ +// tag::code[] package org.springframework.boot.docs.io.jta.mixingxaandnonxaconnections.nonxa import jakarta.jms.ConnectionFactory @@ -21,3 +22,4 @@ import org.springframework.beans.factory.annotation.Qualifier @Suppress("UNUSED_PARAMETER") class MyBean(@Qualifier("nonXaJmsConnectionFactory") connectionFactory: ConnectionFactory?) +// end::code[] \ No newline at end of file diff --git a/spring-boot-project/spring-boot-docs/src/main/kotlin/org/springframework/boot/docs/io/jta/mixingxaandnonxaconnections/primary/MyBean.kt b/spring-boot-project/spring-boot-docs/src/main/kotlin/org/springframework/boot/docs/io/jta/mixingxaandnonxaconnections/primary/MyBean.kt index 5142b0fdbde3..eb0b4451ffc9 100644 --- a/spring-boot-project/spring-boot-docs/src/main/kotlin/org/springframework/boot/docs/io/jta/mixingxaandnonxaconnections/primary/MyBean.kt +++ b/spring-boot-project/spring-boot-docs/src/main/kotlin/org/springframework/boot/docs/io/jta/mixingxaandnonxaconnections/primary/MyBean.kt @@ -14,9 +14,11 @@ * limitations under the License. */ +// tag::code[] package org.springframework.boot.docs.io.jta.mixingxaandnonxaconnections.primary import jakarta.jms.ConnectionFactory @Suppress("UNUSED_PARAMETER") class MyBean(connectionFactory: ConnectionFactory?) +// end::code[] \ No newline at end of file diff --git a/spring-boot-project/spring-boot-docs/src/main/kotlin/org/springframework/boot/docs/io/jta/mixingxaandnonxaconnections/xa/MyBean.kt b/spring-boot-project/spring-boot-docs/src/main/kotlin/org/springframework/boot/docs/io/jta/mixingxaandnonxaconnections/xa/MyBean.kt index fc5f90e71c34..1a860dc2beb6 100644 --- a/spring-boot-project/spring-boot-docs/src/main/kotlin/org/springframework/boot/docs/io/jta/mixingxaandnonxaconnections/xa/MyBean.kt +++ b/spring-boot-project/spring-boot-docs/src/main/kotlin/org/springframework/boot/docs/io/jta/mixingxaandnonxaconnections/xa/MyBean.kt @@ -14,6 +14,7 @@ * limitations under the License. */ +// tag::code[] package org.springframework.boot.docs.io.jta.mixingxaandnonxaconnections.xa import jakarta.jms.ConnectionFactory @@ -21,3 +22,4 @@ import org.springframework.beans.factory.annotation.Qualifier @Suppress("UNUSED_PARAMETER") class MyBean(@Qualifier("xaJmsConnectionFactory") connectionFactory: ConnectionFactory?) +// end::code[] \ No newline at end of file From 98f9a2cd2980bd9dffd512415caba59736468fc6 Mon Sep 17 00:00:00 2001 From: Tran Ngoc Nhan Date: Wed, 16 Oct 2024 23:51:46 +0700 Subject: [PATCH 2/3] Revert properties --- .../boot/build/antora/antora-asciidoc-attributes.properties | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/buildSrc/src/main/resources/org/springframework/boot/build/antora/antora-asciidoc-attributes.properties b/buildSrc/src/main/resources/org/springframework/boot/build/antora/antora-asciidoc-attributes.properties index 95ac27dc67fc..992d303bef70 100644 --- a/buildSrc/src/main/resources/org/springframework/boot/build/antora/antora-asciidoc-attributes.properties +++ b/buildSrc/src/main/resources/org/springframework/boot/build/antora/antora-asciidoc-attributes.properties @@ -33,7 +33,7 @@ url-native-build-tools-docs-gradle-plugin={url-native-build-tools-docs}/gradle-p url-native-build-tools-docs-maven-plugin={url-native-build-tools-docs}/maven-plugin.html url-paketo-docs=https://paketo.io/docs url-paketo-docs-java-buildpack={url-paketo-docs}/buildpacks/language-family-buildpacks/java -url-spring-boot-for-apache-geode-docs=https://docs.spring.io/spring-data/geode/docs/current/reference/html/ +url-spring-boot-for-apache-geode-docs=https://docs.spring.io/spring-boot-data-geode-build/2.0.x/reference/html5 url-spring-boot-for-apache-geode-site=https://github.com/spring-projects/spring-boot-data-geode url-spring-data-cassandra-javadoc=https://docs.spring.io/spring-data/cassandra/docs/{version-spring-data-cassandra-javadoc}/api url-spring-data-cassandra-site=https://spring.io/projects/spring-data-cassandra From 46f802967e7be5f1aa38e5eb96cac9730150d6d0 Mon Sep 17 00:00:00 2001 From: Tran Ngoc Nhan Date: Thu, 17 Oct 2024 01:41:44 +0700 Subject: [PATCH 3/3] Remove code tag --- .../src/docs/antora/modules/reference/pages/io/jta.adoc | 6 +++--- .../io/jta/mixingxaandnonxaconnections/nonxa/MyBean.java | 2 -- .../io/jta/mixingxaandnonxaconnections/primary/MyBean.java | 2 -- .../docs/io/jta/mixingxaandnonxaconnections/xa/MyBean.java | 2 -- .../docs/io/jta/mixingxaandnonxaconnections/nonxa/MyBean.kt | 2 -- .../io/jta/mixingxaandnonxaconnections/primary/MyBean.kt | 2 -- .../docs/io/jta/mixingxaandnonxaconnections/xa/MyBean.kt | 2 -- 7 files changed, 3 insertions(+), 15 deletions(-) diff --git a/spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/io/jta.adoc b/spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/io/jta.adoc index b49f95f94ba4..2edcd9ac0a8f 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/io/jta.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/io/jta.adoc @@ -26,18 +26,18 @@ Spring Boot tries to auto-configure JMS by looking for a `ConnectionFactory` at When using JTA, the primary JMS `ConnectionFactory` bean is XA-aware and participates in distributed transactions. You can inject into your bean without needing to use any `@Qualifier`: -include-code::primary/MyBean[tag=*] +include-code::primary/MyBean[] In some situations, you might want to process certain JMS messages by using a non-XA `ConnectionFactory`. For example, your JMS processing logic might take longer than the XA timeout. If you want to use a non-XA `ConnectionFactory`, you can the `nonXaJmsConnectionFactory` bean: -include-code::nonxa/MyBean[tag=*] +include-code::nonxa/MyBean[] For consistency, the `jmsConnectionFactory` bean is also provided by using the bean alias `xaJmsConnectionFactory`: -include-code::xa/MyBean[tag=*] +include-code::xa/MyBean[] diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/io/jta/mixingxaandnonxaconnections/nonxa/MyBean.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/io/jta/mixingxaandnonxaconnections/nonxa/MyBean.java index a7d843c9b180..2eae0e31154d 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/io/jta/mixingxaandnonxaconnections/nonxa/MyBean.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/io/jta/mixingxaandnonxaconnections/nonxa/MyBean.java @@ -22,10 +22,8 @@ public class MyBean { - // tag::code[] public MyBean(@Qualifier("nonXaJmsConnectionFactory") ConnectionFactory connectionFactory) { // ... } - // end::code[] } diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/io/jta/mixingxaandnonxaconnections/primary/MyBean.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/io/jta/mixingxaandnonxaconnections/primary/MyBean.java index d4d11c7cc3b1..68e9016cd662 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/io/jta/mixingxaandnonxaconnections/primary/MyBean.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/io/jta/mixingxaandnonxaconnections/primary/MyBean.java @@ -20,10 +20,8 @@ public class MyBean { - // tag::code[] public MyBean(ConnectionFactory connectionFactory) { // ... } - // end::code[] } diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/io/jta/mixingxaandnonxaconnections/xa/MyBean.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/io/jta/mixingxaandnonxaconnections/xa/MyBean.java index ab5c4f63a9bf..6e8d226f892a 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/io/jta/mixingxaandnonxaconnections/xa/MyBean.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/io/jta/mixingxaandnonxaconnections/xa/MyBean.java @@ -22,10 +22,8 @@ public class MyBean { - // tag::code[] public MyBean(@Qualifier("xaJmsConnectionFactory") ConnectionFactory connectionFactory) { // ... } - // end::code[] } diff --git a/spring-boot-project/spring-boot-docs/src/main/kotlin/org/springframework/boot/docs/io/jta/mixingxaandnonxaconnections/nonxa/MyBean.kt b/spring-boot-project/spring-boot-docs/src/main/kotlin/org/springframework/boot/docs/io/jta/mixingxaandnonxaconnections/nonxa/MyBean.kt index 33f81cbcc60d..690d857acb1c 100644 --- a/spring-boot-project/spring-boot-docs/src/main/kotlin/org/springframework/boot/docs/io/jta/mixingxaandnonxaconnections/nonxa/MyBean.kt +++ b/spring-boot-project/spring-boot-docs/src/main/kotlin/org/springframework/boot/docs/io/jta/mixingxaandnonxaconnections/nonxa/MyBean.kt @@ -14,7 +14,6 @@ * limitations under the License. */ -// tag::code[] package org.springframework.boot.docs.io.jta.mixingxaandnonxaconnections.nonxa import jakarta.jms.ConnectionFactory @@ -22,4 +21,3 @@ import org.springframework.beans.factory.annotation.Qualifier @Suppress("UNUSED_PARAMETER") class MyBean(@Qualifier("nonXaJmsConnectionFactory") connectionFactory: ConnectionFactory?) -// end::code[] \ No newline at end of file diff --git a/spring-boot-project/spring-boot-docs/src/main/kotlin/org/springframework/boot/docs/io/jta/mixingxaandnonxaconnections/primary/MyBean.kt b/spring-boot-project/spring-boot-docs/src/main/kotlin/org/springframework/boot/docs/io/jta/mixingxaandnonxaconnections/primary/MyBean.kt index eb0b4451ffc9..5142b0fdbde3 100644 --- a/spring-boot-project/spring-boot-docs/src/main/kotlin/org/springframework/boot/docs/io/jta/mixingxaandnonxaconnections/primary/MyBean.kt +++ b/spring-boot-project/spring-boot-docs/src/main/kotlin/org/springframework/boot/docs/io/jta/mixingxaandnonxaconnections/primary/MyBean.kt @@ -14,11 +14,9 @@ * limitations under the License. */ -// tag::code[] package org.springframework.boot.docs.io.jta.mixingxaandnonxaconnections.primary import jakarta.jms.ConnectionFactory @Suppress("UNUSED_PARAMETER") class MyBean(connectionFactory: ConnectionFactory?) -// end::code[] \ No newline at end of file diff --git a/spring-boot-project/spring-boot-docs/src/main/kotlin/org/springframework/boot/docs/io/jta/mixingxaandnonxaconnections/xa/MyBean.kt b/spring-boot-project/spring-boot-docs/src/main/kotlin/org/springframework/boot/docs/io/jta/mixingxaandnonxaconnections/xa/MyBean.kt index 1a860dc2beb6..fc5f90e71c34 100644 --- a/spring-boot-project/spring-boot-docs/src/main/kotlin/org/springframework/boot/docs/io/jta/mixingxaandnonxaconnections/xa/MyBean.kt +++ b/spring-boot-project/spring-boot-docs/src/main/kotlin/org/springframework/boot/docs/io/jta/mixingxaandnonxaconnections/xa/MyBean.kt @@ -14,7 +14,6 @@ * limitations under the License. */ -// tag::code[] package org.springframework.boot.docs.io.jta.mixingxaandnonxaconnections.xa import jakarta.jms.ConnectionFactory @@ -22,4 +21,3 @@ import org.springframework.beans.factory.annotation.Qualifier @Suppress("UNUSED_PARAMETER") class MyBean(@Qualifier("xaJmsConnectionFactory") connectionFactory: ConnectionFactory?) -// end::code[] \ No newline at end of file