diff --git a/documentation/src/main/asciidoc/migration/index.adoc b/documentation/src/main/asciidoc/migration/index.adoc index f98d8b0052f..855b9524659 100644 --- a/documentation/src/main/asciidoc/migration/index.adoc +++ b/documentation/src/main/asciidoc/migration/index.adoc @@ -322,7 +322,7 @@ Additionally, some configuration properties have been deprecated: * `hibernate.search.automatic_indexing.synchronization.strategy` is now deprecated in favor of `hibernate.search.indexing.plan.synchronization.strategy`. * `hibernate.search.automatic_indexing.enabled` is now deprecated in favor of `hibernate.search.indexing.listeners.enabled`. * `hibernate.search.automatic_indexing.enable_dirty_check` is now deprecated with no alternative to replace it. -A dirty check will always be performed when considering triggering the reindexing. +After its removal in a future version, a dirty check will always be performed when considering whether to trigger reindexing. [[api]] == API changes diff --git a/integrationtest/mapper/orm/src/test/java/org/hibernate/search/integrationtest/mapper/orm/automaticindexing/AutomaticIndexingDirtyCheckIT.java b/integrationtest/mapper/orm/src/test/java/org/hibernate/search/integrationtest/mapper/orm/automaticindexing/AutomaticIndexingDirtyCheckIT.java index a0b5301723d..e7b30c6949b 100644 --- a/integrationtest/mapper/orm/src/test/java/org/hibernate/search/integrationtest/mapper/orm/automaticindexing/AutomaticIndexingDirtyCheckIT.java +++ b/integrationtest/mapper/orm/src/test/java/org/hibernate/search/integrationtest/mapper/orm/automaticindexing/AutomaticIndexingDirtyCheckIT.java @@ -31,7 +31,8 @@ public class AutomaticIndexingDirtyCheckIT { + "'hibernate.search.automatic_indexing.enable_dirty_check' is deprecated. " + "This setting will be removed in a future version. " + "There will be no alternative provided to replace it. " - + "A dirty check will always be performed when considering triggering the reindexing."; + + "After the removal of this property in a future version, " + + "a dirty check will always be performed when considering whether to trigger reindexing."; @Rule public BackendMock backendMock = new BackendMock(); diff --git a/mapper/orm/src/main/java/org/hibernate/search/mapper/orm/cfg/HibernateOrmMapperSettings.java b/mapper/orm/src/main/java/org/hibernate/search/mapper/orm/cfg/HibernateOrmMapperSettings.java index 3697795cbc7..a093805853a 100644 --- a/mapper/orm/src/main/java/org/hibernate/search/mapper/orm/cfg/HibernateOrmMapperSettings.java +++ b/mapper/orm/src/main/java/org/hibernate/search/mapper/orm/cfg/HibernateOrmMapperSettings.java @@ -98,7 +98,8 @@ private HibernateOrmMapperSettings() { * Defaults to {@link Defaults#AUTOMATIC_INDEXING_ENABLE_DIRTY_CHECK}. * * @deprecated This setting will be removed in a future version. There will be no alternative provided to replace it. - * A dirty check will always be performed when considering triggering the reindexing. + * After the removal of this property in a future version, + * a dirty check will always be performed when considering whether to trigger reindexing. */ @Deprecated public static final String AUTOMATIC_INDEXING_ENABLE_DIRTY_CHECK = PREFIX + Radicals.AUTOMATIC_INDEXING_ENABLE_DIRTY_CHECK; @@ -260,7 +261,8 @@ private Radicals() { AUTOMATIC_INDEXING_PREFIX + AutomaticIndexingRadicals.SYNCHRONIZATION_STRATEGY; /** * @deprecated This setting will be removed in a future version. There will be no alternative provided to replace it. - * A dirty check will always be performed when considering triggering the reindexing. + * After the removal of this property in a future version, + * a dirty check will always be performed when considering whether to trigger reindexing. */ @Deprecated public static final String AUTOMATIC_INDEXING_ENABLE_DIRTY_CHECK = @@ -310,7 +312,8 @@ private AutomaticIndexingRadicals() { public static final String SYNCHRONIZATION_STRATEGY = "synchronization.strategy"; /** * @deprecated This setting will be removed in a future version. There will be no alternative provided to replace it. - * A dirty check will always be performed when considering triggering the reindexing. + * After the removal of this property in a future version, + * a dirty check will always be performed when considering whether to trigger reindexing. */ @Deprecated public static final String ENABLE_DIRTY_CHECK = "enable_dirty_check"; @@ -381,7 +384,8 @@ private Defaults() { "write-sync" ); /** * @deprecated This setting will be removed in a future version. There will be no alternative provided to replace it. - * A dirty check will always be performed when considering triggering the reindexing. + * After the removal of this property in a future version, + * a dirty check will always be performed when considering whether to trigger reindexing. */ @Deprecated public static final boolean AUTOMATIC_INDEXING_ENABLE_DIRTY_CHECK = true; diff --git a/mapper/orm/src/main/java/org/hibernate/search/mapper/orm/logging/impl/Log.java b/mapper/orm/src/main/java/org/hibernate/search/mapper/orm/logging/impl/Log.java index 6a8b56d2116..6fbfb8b0059 100644 --- a/mapper/orm/src/main/java/org/hibernate/search/mapper/orm/logging/impl/Log.java +++ b/mapper/orm/src/main/java/org/hibernate/search/mapper/orm/logging/impl/Log.java @@ -335,7 +335,8 @@ void failedToResolveStateRepresentation(String path, @FormatWith(EventContextFor @Message(id = ID_OFFSET + 125, value = "Configuration property '%1$s' is deprecated. " + "This setting will be removed in a future version. " + "There will be no alternative provided to replace it. " - + "A dirty check will always be performed when considering triggering the reindexing.") + + "After the removal of this property in a future version, " + + "a dirty check will always be performed when considering whether to trigger reindexing.") void automaticIndexingEnableDirtyCheckIsDeprecated(String deprecatedProperty); @Message(id = ID_OFFSET + 126,