Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions documentation/documentation.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,13 @@ plugins {

id "org.hibernate.orm.build.reports"

id 'org.asciidoctor.jvm.convert' version '4.0.2'
id 'org.asciidoctor.jvm.pdf' version '4.0.2'
id "org.asciidoctor.jvm.gems" version "4.0.2"
id 'org.asciidoctor.jvm.convert' version '4.0.5'
id 'org.asciidoctor.jvm.pdf' version '4.0.5'
id "org.hibernate.orm.build.settings-doc"
}

repositories {
mavenCentral()
ruby.gems()
}

def hibernateVersion = ormBuildDetails.hibernateVersion
Expand Down Expand Up @@ -135,8 +133,6 @@ dependencies {
reportAggregation project(':hibernate-maven-plugin')
reportAggregation project(':hibernate-processor')

asciidoctorGems 'rubygems:rouge:4.1.1'

core project( ':hibernate-core' )
javadocSources project( path: ':hibernate-core', configuration: 'javadocSources' )

Expand Down Expand Up @@ -227,19 +223,23 @@ def aggregateJavadocsTask = tasks.register( "javadoc", Javadoc ) {

asciidoctorj {
requires 'rouge'
// Set version of AsciidoctorJ (plugin is currently uses 2.5.7 ? by default)
version '3.0.0'
modules {
pdf {
version '2.3.7'
version '2.3.18'
}
}
attributes icons: 'font',
attributes icons: 'font',
experimental: true,
'source-highlighter': 'rouge',
majorMinorVersion: hibernateVersion.family,
fullVersion: hibernateVersion.fullName,
javaCompatibleVersions: jdks.versions.compatible.get(),
jakartaJpaVersion: jpaVersion.name,
jdbcVersion: jdks.versions.jdbc.get()
jdbcVersion: jdks.versions.jdbc.get(),
'root-project-dir': rootProject.layout.projectDirectory.asFile.absolutePath,
'doc-main-dir': project( ':documentation').layout.projectDirectory.dir('src').dir("main").asFile.absolutePath

options logDocuments: true
}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
:shared-attributes-dir: ../shared/
:shared-attributes-dir: ../shared

include::{shared-attributes-dir}/common-attributes.adoc[]
include::{shared-attributes-dir}/url-attributes.adoc[]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
:shared-attributes-dir: ../shared/
:shared-attributes-dir: ../shared

include::{shared-attributes-dir}/common-attributes.adoc[]
include::{shared-attributes-dir}/url-attributes.adoc[]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
:shared-attributes-dir: ../../shared/
:shared-attributes-dir: ../../shared

include::{shared-attributes-dir}/common-attributes.adoc[]
include::{shared-attributes-dir}/url-attributes.adoc[]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
:shared-attributes-dir: ../shared/
:shared-attributes-dir: ../shared

include::{shared-attributes-dir}/common-attributes.adoc[]
include::{shared-attributes-dir}/url-attributes.adoc[]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,12 @@
// Centralized definition of Asciidoc attributes for local filesystem paths
// ****************************************************************************

:doc-main-dir: ../..
:doc-main-asciidoc-dir: {doc-main-dir}/asciidoc
:doc-main-style-dir: {doc-main-dir}/style
:pdf-theme: {doc-main-style-dir}/pdf/theme.yml
:pdf-fontsdir: {doc-main-style-dir}/pdf/fonts
//:title-logo-image: {doc-main-style-dir}/asciidoctor/images/org/hibernate/logo.png[]

:root-project-dir: ../../../../..
:core-project-dir: {root-project-dir}/hibernate-core
:documentation-project-dir: {root-project-dir}/documentation
:testing-project-dir: {root-project-dir}/hibernate-testing
2 changes: 1 addition & 1 deletion documentation/src/main/asciidoc/topical/index.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
:shared-attributes-dir: ../shared/
:shared-attributes-dir: ../shared

include::{shared-attributes-dir}/common-attributes.adoc[]
include::{shared-attributes-dir}/url-attributes.adoc[]
Expand Down
4 changes: 2 additions & 2 deletions documentation/src/main/asciidoc/topical/logging/Logging.adoc
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
:shared-attributes-dir: ../../shared/
:shared-attributes-dir: {doc-main-dir}/asciidoc/shared

include::{shared-attributes-dir}/common-attributes.adoc[]
include::{shared-attributes-dir}/url-attributes.adoc[]
include::{shared-attributes-dir}/filesystem-attributes.adoc[]
include::{shared-attributes-dir}/renderer-attributes.adoc[]

:jboss-logging-url:
:jboss-logging-url: https://github.com/jboss-logging

[[root]]
= Logging
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
:shared-attributes-dir: ../shared/
:shared-attributes-dir: ../shared

include::{shared-attributes-dir}/common-attributes.adoc[]
include::{shared-attributes-dir}/url-attributes.adoc[]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
:root-project-dir: ../../../../../..
:core-project-dir: {root-project-dir}/hibernate-core
:sourcedir: {core-project-dir}/src/test/java/org/hibernate/orm/test/mapping
:extrasdir: extras
Expand Down Expand Up @@ -319,4 +318,4 @@ When running the previous test case against the `BitSetUserType` entity mapping,
----
include::{originalextrasdir}/basic/basic-custom-type-BitSetUserType-persistence-sql-example.sql[]
----
====
====
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
[[batch]]
== Batching
:root-project-dir: ../../../../../../..
:core-project-dir: {root-project-dir}/hibernate-core
:example-dir-doc-batch: {core-project-dir}/src/test/java/org/hibernate/orm/test/batch
:example-dir-bulkid: {core-project-dir}/src/test/java/org/hibernate/orm/test/bulkid
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
:asciidoc-dir: ../../..
include::{asciidoc-dir}/shared/common-attributes.adoc[]

:root-project-dir: ../../../../../../..
:core-project-dir: {root-project-dir}/hibernate-core
:core-test-base: {core-project-dir}/src/test/java/org/hibernate/orm/test
:example-dir-boot: {core-test-base}/bootstrap
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
[[caching]]
== Caching
:root-project-dir: ../../../../../../..
:jcache-project-dir: {root-project-dir}/hibernate-jcache
:example-dir-caching: {jcache-project-dir}/src/test/java/org/hibernate/orm/test/caching

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
[[access]]
=== Access strategies
:root-project-dir: ../../../../../../..
:core-project-dir: {root-project-dir}/hibernate-core
:example-dir-access: {core-project-dir}/src/test/java/org/hibernate/orm/test/mapping/access
:extrasdir: extras
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
[[associations]]
=== Associations
:root-project-dir: ../../../../../../..
:core-project-dir: {root-project-dir}/hibernate-core
:example-dir-association: {core-project-dir}/src/test/java/org/hibernate/orm/test/associations
:example-dir-any: {core-project-dir}/src/test/java/org/hibernate/orm/test/any
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
[[basic]]
=== Basic values
:root-project-dir: ../../../../../../..
:testing-project-dir: {root-project-dir}/hibernate-testing
:example-dir-model: {testing-project-dir}/src/main/java/org/hibernate/testing/orm/domain/userguide
:core-project-dir: {root-project-dir}/hibernate-core
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
[[collections]]
=== Collections
:root-project-dir: ../../../../../../..
:core-project-dir: {root-project-dir}/hibernate-core
:core-test-base: {core-project-dir}/src/test/java
:example-dir-collection: {core-test-base}/org/hibernate/orm/test/mapping/collections
Expand Down Expand Up @@ -241,7 +240,7 @@ include::{example-dir-collection}/classification/map/EntityWithSortedMap.java[ta



[[collections-bag]]
[[collections-mapping]]
==== Mapping Collections

Without any other mapping influencers, `java.util.Collection` is interpreted using BAG
Expand Down Expand Up @@ -786,7 +785,7 @@ include::{extrasdir}/collections-customizing-ordered-by-sql-clause-fetching-exam
----
====

[[collections-set]]
[[collections-set-types]]
==== Sets

Sets are collections that don't allow duplicate entries and Hibernate supports both the unordered `Set` and the natural-ordering `SortedSet`.
Expand Down Expand Up @@ -885,7 +884,7 @@ Before v6, `@SortNatural` must be used if collection element's natural ordering
Starting from v6, we can omit `@SortNatural` as it will take effect by default.
====

[[collections-map]]
[[collections-map-types]]
==== Maps

A `java.util.Map` is a ternary association because it requires a parent entity, a map key, and a value.
Expand Down Expand Up @@ -1080,7 +1079,7 @@ include::{extrasdir}/collections-map-bidirectional-example.sql[]
----
====

[[collections-array]]
[[collections-array-types]]
==== Arrays

When discussing arrays, it is important to understand the distinction between SQL array types and Java arrays that are mapped as part of the application's domain model.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
[[domain-customizing]]
=== Customizing the domain model
:root-project-dir: ../../../../../../..
:core-project-dir: {root-project-dir}/hibernate-core
:example-dir-attributebinder: {core-project-dir}/src/test/java/org/hibernate/orm/test/mapping/attributebinder
:extrasdir: extras
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
[[dynamic-model]]
=== Dynamic Model
:root-project-dir: ../../../../../../..
:core-project-dir: {root-project-dir}/hibernate-core
:example-dir-dynamic: {core-project-dir}/src/test/java/org/hibernate/orm/test/mapping/dynamic
:example-dir-resources: {core-project-dir}/src/test/resources/org/hibernate/orm/test/mapping/dynamic
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
[[embeddables]]
=== Embeddable values
:root-project-dir: ../../../../../../..
:core-project-dir: {root-project-dir}/hibernate-core
:core-test-base: {root-project-dir}/hibernate-core/src/test/java
:example-dir-emeddable: {core-test-base}/org/hibernate/orm/test/mapping/embeddable
Expand Down Expand Up @@ -764,4 +763,4 @@ Again, the name and the nullability of the `aggregate` column can be refined thr
Mapping <<chapters/domain/collections.adoc#collections,collections>> inside an `@Embeddable` value is supported in most cases. There are a couple exceptions:

* If the values of an <<chapters/domain/collections.adoc#collections-elemental,@ElementCollection>> is of embeddable type, that embeddable cannot contain nested collections;
* Explicitly selecting an embeddable that contains collections in a query is currently not supported (we wouldn't be able to correctly initialize the collection since its owning entity instance would be missing from the Persistence Context).
* Explicitly selecting an embeddable that contains collections in a query is currently not supported (we wouldn't be able to correctly initialize the collection since its owning entity instance would be missing from the Persistence Context).
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
[[entity]]
=== Entity types
:root-project-dir: ../../../../../../..
:core-project-dir: {root-project-dir}/hibernate-core
:core-test-base: {core-project-dir}/src/test/java/org/hibernate/orm/test
:example-dir-mapping: {core-test-base}/mapping
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
[[identifiers]]
=== Identifiers
:root-project-dir: ../../../../../../..
:core-project-dir: {root-project-dir}/hibernate-core
:core-test-base: {core-project-dir}/src/test/java/org/hibernate/orm/test
:example-dir-identifier: {core-test-base}/mapping/identifier
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
[[mutability]]
=== Mutability
:root-project-dir: ../../../../../../..
:core-project-dir: {root-project-dir}/hibernate-core
:mutability-example-dir: {core-project-dir}/src/test/java/org/hibernate/orm/test/mapping/mutability
:extrasdir: extras/immutability
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
[[entity-inheritance]]
=== Inheritance
:root-project-dir: ../../../../../../..
:core-project-dir: {root-project-dir}/hibernate-core
:example-dir-inheritance: {core-project-dir}/src/test/java/org/hibernate/orm/test/inheritance
:extrasdir: extras/inheritance
Expand Down Expand Up @@ -368,4 +367,4 @@ This is the resulting table structure:
[source,sql]
----
include::{extrasdir}/embeddable-inheritance-create-table-example.sql[]
----
----
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
[[naming]]
=== Naming strategies
:root-project-dir: ../../../../../../..
:core-project-dir: {root-project-dir}/hibernate-core
:example-dir-naming: {core-project-dir}/src/test/java/org/hibernate/orm/test/naming

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
[[naturalid]]
=== Natural Ids
:root-project-dir: ../../../../../../..
:core-project-dir: {root-project-dir}/hibernate-core
:example-dir-naturalid: {core-project-dir}/src/test/java/org/hibernate/orm/test/mapping/identifier
:jcache-project-dir: {root-project-dir}/hibernate-jcache
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
[[partitioning]]
=== Partitioning
:root-project-dir: ../../../../../../..
:core-project-dir: {root-project-dir}/hibernate-core
:example-dir-partition-key: {core-project-dir}/src/test/java/org/hibernate/orm/test/mapping/identifier
:extrasdir: extras
Expand Down Expand Up @@ -38,4 +37,4 @@ When updating or deleting an entity, Hibernate will include a partition key cons
update user_tbl set firstname=?,lastname=?,tenantKey=? where id=? and tenantKey=?
delete from user_tbl where id=? and tenantKey=?
----
====
====
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
[[soft-delete]]
=== Soft Delete
:root-project-dir: ../../../../../../..
:core-project-dir: {root-project-dir}/hibernate-core
:testing-dir: {core-project-dir}/src/test/java/org/hibernate/orm/test/softdelete

Expand Down Expand Up @@ -103,8 +102,8 @@ For entity hierarchies, the soft delete applies to all inheritance types.
====
[source,java]
----
include::{testing-dir}/secondary/JoinedRoot.java[tag=example-soft-delete-secondary, indent=0]
include::{testing-dir}/secondary/JoinedSub.java[tag=example-soft-delete-secondary, indent=0]
include::{testing-dir}/discovery/secondary/JoinedRoot.java[tag=example-soft-delete-secondary, indent=0]
include::{testing-dir}/discovery/secondary/JoinedSub.java[tag=example-soft-delete-secondary, indent=0]
----
====

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
[[mapping-types]]
=== Mapping types
:root-project-dir: ../../../../../../..
:core-project-dir: {root-project-dir}/hibernate-core
:example-dir-mapping: {core-project-dir}/src/test/java/org/hibernate/orm/test/mapping
:extrasdir: extras/types
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
[[envers]]
== Envers
:root-project-dir: ../../../../../../..
:envers-project-dir: {root-project-dir}/hibernate-envers
:example-dir-envers: {envers-project-dir}/src/test/java/org/hibernate/orm/test/envers
:extrasdir: extras
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
[[events]]
== Interceptors and Events
:root-project-dir: ../../../../../../..
:core-project-dir: {root-project-dir}/hibernate-core
:example-dir-event: {core-project-dir}/src/test/java/org/hibernate/orm/test/events
:example-dir-event-resources: {core-project-dir}/src/test/resources/org/hibernate/orm/test/events
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
[[fetching]]
== Fetching
:root-project-dir: ../../../../../../..
:core-project-dir: {root-project-dir}/hibernate-core
:example-dir-fetching: {core-project-dir}/src/test/java/org/hibernate/orm/test/fetching
:extrasdir: extras
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
[[flushing]]
== Flushing
:root-project-dir: ../../../../../../..
:core-project-dir: {root-project-dir}/hibernate-core
:example-dir-flushing: {core-project-dir}/src/test/java/org/hibernate/orm/test/flush
:extrasdir: extras
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
[[locking]]
== Locking
:root-project-dir: ../../../../../../..
:core-project-dir: {root-project-dir}/hibernate-core
:example-dir-locking: {core-project-dir}/src/test/java/org/hibernate/orm/test/locking
:extrasdir: extras
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
[[multitenacy]]
== Multitenancy
:root-project-dir: ../../../../../../..
:core-project-dir: {root-project-dir}/hibernate-core
:example-dir-multitenancy: {core-project-dir}/src/test/java/org/hibernate/orm/test/multitenancy
:extrasdir: extras
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
[[BytecodeEnhancement]]
=== Bytecode Enhancement
:root-project-dir: ../../../../../../..
:core-project-dir: {root-project-dir}/hibernate-core
:example-dir-enhancement: {core-project-dir}/src/test/java/org/hibernate/orm/test/pc

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
[[pc]]
== Persistence Context
:root-project-dir: ../../../../../../..
:core-project-dir: {root-project-dir}/hibernate-core
:example-dir-pc: {core-project-dir}/src/test/java/org/hibernate/orm/test/pc
:jcache-project-dir: {root-project-dir}/hibernate-jcache
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
[[criteria]]
== Criteria
:root-project-dir: ../../../../../../../..
:core-project-dir: {root-project-dir}/hibernate-core
:example-dir-criteria: {core-project-dir}/src/test/java/org/hibernate/orm/test/query/criteria

Expand Down
Loading