Sync documentation of main branch

quarkusio · Aug 8, 2024 · b11d02c · b11d02c
1 parent d058c21
commit b11d02c
Show file tree

Hide file tree

Showing 10 changed files with 738 additions and 1,116 deletions.
diff --git a/_generated-doc/main/config/quarkus-all-build-items.adoc b/_generated-doc/main/config/quarkus-all-build-items.adoc
@@ -701,6 +701,10 @@ _No Javadoc found_
 
 _No Javadoc found_
 
+`java.lang.String description` 
+
+_No Javadoc found_
+
 `io.quarkus.deployment.dev.devservices.ContainerInfo containerInfo` 
 
 _No Javadoc found_
@@ -760,6 +764,10 @@ BuildItem for running dev services. Combines injected configs to the application
 
 _No Javadoc found_
 
+`java.lang.String description` 
+
+_No Javadoc found_
+
 `java.lang.String containerId` 
 
 _No Javadoc found_

diff --git a/_generated-doc/main/config/quarkus-core.adoc b/_generated-doc/main/config/quarkus-core.adoc
@@ -77,6 +77,42 @@ endif::add-copy-button-to-env-var[]
 |`Build system locale`
 
 
+a| [[quarkus-core_quarkus-init-and-exit]]`link:#quarkus-core_quarkus-init-and-exit[quarkus.init-and-exit]`
+
+
+[.description]
+--
+true to quit exit right after the initialization. The option is not meant be used directly by users.
+
+ifdef::add-copy-button-to-env-var[]
+Environment variable: env_var_with_copy_button:+++QUARKUS_INIT_AND_EXIT+++[]
+endif::add-copy-button-to-env-var[]
+ifndef::add-copy-button-to-env-var[]
+Environment variable: `+++QUARKUS_INIT_AND_EXIT+++`
+endif::add-copy-button-to-env-var[]
+--|@io.smallrye.config.WithConverter(io.quarkus.runtime.init.InitRuntimeConfig.BooleanConverter.class) boolean 
+|`false`
+
+
+a| [[quarkus-core_quarkus-args]]`link:#quarkus-core_quarkus-args[quarkus.args]`
+
+
+[.description]
+--
+The arguments passed to the command line.
+
+We don't make it a list as the args are separated by a space, not a comma.
+
+ifdef::add-copy-button-to-env-var[]
+Environment variable: env_var_with_copy_button:+++QUARKUS_ARGS+++[]
+endif::add-copy-button-to-env-var[]
+ifndef::add-copy-button-to-env-var[]
+Environment variable: `+++QUARKUS_ARGS+++`
+endif::add-copy-button-to-env-var[]
+--|string 
+|
+
+
 a| [[quarkus-core_quarkus-profile]]`link:#quarkus-core_quarkus-profile[quarkus.profile]`
 
 
@@ -182,42 +218,6 @@ endif::add-copy-button-to-env-var[]
 |
 
 
-a| [[quarkus-core_quarkus-init-and-exit]]`link:#quarkus-core_quarkus-init-and-exit[quarkus.init-and-exit]`
-
-
-[.description]
---
-true to quit exit right after the initialization. The option is not meant be used directly by users.
-
-ifdef::add-copy-button-to-env-var[]
-Environment variable: env_var_with_copy_button:+++QUARKUS_INIT_AND_EXIT+++[]
-endif::add-copy-button-to-env-var[]
-ifndef::add-copy-button-to-env-var[]
-Environment variable: `+++QUARKUS_INIT_AND_EXIT+++`
-endif::add-copy-button-to-env-var[]
---|@io.smallrye.config.WithConverter(io.quarkus.runtime.init.InitRuntimeConfig.BooleanConverter.class) boolean 
-|`false`
-
-
-a| [[quarkus-core_quarkus-args]]`link:#quarkus-core_quarkus-args[quarkus.args]`
-
-
-[.description]
---
-The arguments passed to the command line.
-
-We don't make it a list as the args are separated by a space, not a comma.
-
-ifdef::add-copy-button-to-env-var[]
-Environment variable: env_var_with_copy_button:+++QUARKUS_ARGS+++[]
-endif::add-copy-button-to-env-var[]
-ifndef::add-copy-button-to-env-var[]
-Environment variable: `+++QUARKUS_ARGS+++`
-endif::add-copy-button-to-env-var[]
---|string 
-|
-
-
 a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-analytics-disabled]]`link:#quarkus-core_quarkus-analytics-disabled[quarkus.analytics.disabled]`
 
 

diff --git a/...ernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-database.adoc b/...ernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-database.adoc
@@ -67,100 +67,4 @@ endif::add-copy-button-to-env-var[]
 
 |`UTF-8`
 
-
-a| [[quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-database_quarkus-hibernate-orm-database-generation]]`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-database_quarkus-hibernate-orm-database-generation[quarkus.hibernate-orm.database.generation]`
-
-`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-database_quarkus-hibernate-orm-database-generation[quarkus.hibernate-orm."persistence-unit-name".database.generation]`
-
-
-[.description]
---
-Select whether the database schema is generated or not. `drop-and-create` is awesome in development mode. This defaults to 'none', however if Dev Services is in use and no other extensions that manage the schema are present this will default to 'drop-and-create'. Accepted values: `none`, `create`, `drop-and-create`, `drop`, `update`, `validate`.
-
-ifdef::add-copy-button-to-env-var[]
-Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION+++[]
-endif::add-copy-button-to-env-var[]
-ifndef::add-copy-button-to-env-var[]
-Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION+++`
-endif::add-copy-button-to-env-var[]
---|link:https://docs.oracle.com/javase/8/docs/api/java/lang/String.html[String]
-
-|`none`
-
-
-a| [[quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-database_quarkus-hibernate-orm-database-generation-create-schemas]]`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-database_quarkus-hibernate-orm-database-generation-create-schemas[quarkus.hibernate-orm.database.generation.create-schemas]`
-
-`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-database_quarkus-hibernate-orm-database-generation-create-schemas[quarkus.hibernate-orm."persistence-unit-name".database.generation.create-schemas]`
-
-
-[.description]
---
-If Hibernate ORM should create the schemas automatically (for databases supporting them).
-
-ifdef::add-copy-button-to-env-var[]
-Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION_CREATE_SCHEMAS+++[]
-endif::add-copy-button-to-env-var[]
-ifndef::add-copy-button-to-env-var[]
-Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION_CREATE_SCHEMAS+++`
-endif::add-copy-button-to-env-var[]
---|boolean 
-|`false`
-
-
-a| [[quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-database_quarkus-hibernate-orm-database-generation-halt-on-error]]`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-database_quarkus-hibernate-orm-database-generation-halt-on-error[quarkus.hibernate-orm.database.generation.halt-on-error]`
-
-`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-database_quarkus-hibernate-orm-database-generation-halt-on-error[quarkus.hibernate-orm."persistence-unit-name".database.generation.halt-on-error]`
-
-
-[.description]
---
-Whether we should stop on the first error when applying the schema.
-
-ifdef::add-copy-button-to-env-var[]
-Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION_HALT_ON_ERROR+++[]
-endif::add-copy-button-to-env-var[]
-ifndef::add-copy-button-to-env-var[]
-Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION_HALT_ON_ERROR+++`
-endif::add-copy-button-to-env-var[]
---|boolean 
-|`false`
-
-
-a| [[quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-database_quarkus-hibernate-orm-database-default-catalog]]`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-database_quarkus-hibernate-orm-database-default-catalog[quarkus.hibernate-orm.database.default-catalog]`
-
-`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-database_quarkus-hibernate-orm-database-default-catalog[quarkus.hibernate-orm."persistence-unit-name".database.default-catalog]`
-
-
-[.description]
---
-The default catalog to use for the database objects.
-
-ifdef::add-copy-button-to-env-var[]
-Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_DATABASE_DEFAULT_CATALOG+++[]
-endif::add-copy-button-to-env-var[]
-ifndef::add-copy-button-to-env-var[]
-Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_DEFAULT_CATALOG+++`
-endif::add-copy-button-to-env-var[]
---|string 
-|
-
-
-a| [[quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-database_quarkus-hibernate-orm-database-default-schema]]`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-database_quarkus-hibernate-orm-database-default-schema[quarkus.hibernate-orm.database.default-schema]`
-
-`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-database_quarkus-hibernate-orm-database-default-schema[quarkus.hibernate-orm."persistence-unit-name".database.default-schema]`
-
-
-[.description]
---
-The default schema to use for the database objects.
-
-ifdef::add-copy-button-to-env-var[]
-Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_DATABASE_DEFAULT_SCHEMA+++[]
-endif::add-copy-button-to-env-var[]
-ifndef::add-copy-button-to-env-var[]
-Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_DEFAULT_SCHEMA+++`
-endif::add-copy-button-to-env-var[]
---|string 
-|
-
 |===
diff --git a/...s-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-log.adoc b/...s-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-log.adoc
@@ -28,101 +28,4 @@ endif::add-copy-button-to-env-var[]
 --|boolean 
 |`false`
 
-
-a| [[quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-log_quarkus-hibernate-orm-log-sql]]`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-log_quarkus-hibernate-orm-log-sql[quarkus.hibernate-orm.log.sql]`
-
-`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-log_quarkus-hibernate-orm-log-sql[quarkus.hibernate-orm."persistence-unit-name".log.sql]`
-
-
-[.description]
---
-Show SQL logs and format them nicely.
-
-Setting it to true is obviously not recommended in production.
-
-ifdef::add-copy-button-to-env-var[]
-Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_LOG_SQL+++[]
-endif::add-copy-button-to-env-var[]
-ifndef::add-copy-button-to-env-var[]
-Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_SQL+++`
-endif::add-copy-button-to-env-var[]
---|boolean 
-|`false`
-
-
-a| [[quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-log_quarkus-hibernate-orm-log-format-sql]]`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-log_quarkus-hibernate-orm-log-format-sql[quarkus.hibernate-orm.log.format-sql]`
-
-`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-log_quarkus-hibernate-orm-log-format-sql[quarkus.hibernate-orm."persistence-unit-name".log.format-sql]`
-
-
-[.description]
---
-Format the SQL logs if SQL log is enabled
-
-ifdef::add-copy-button-to-env-var[]
-Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_LOG_FORMAT_SQL+++[]
-endif::add-copy-button-to-env-var[]
-ifndef::add-copy-button-to-env-var[]
-Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_FORMAT_SQL+++`
-endif::add-copy-button-to-env-var[]
---|boolean 
-|`true`
-
-
-a| [[quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-log_quarkus-hibernate-orm-log-highlight-sql]]`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-log_quarkus-hibernate-orm-log-highlight-sql[quarkus.hibernate-orm.log.highlight-sql]`
-
-`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-log_quarkus-hibernate-orm-log-highlight-sql[quarkus.hibernate-orm."persistence-unit-name".log.highlight-sql]`
-
-
-[.description]
---
-Highlight the SQL logs if SQL log is enabled
-
-ifdef::add-copy-button-to-env-var[]
-Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_LOG_HIGHLIGHT_SQL+++[]
-endif::add-copy-button-to-env-var[]
-ifndef::add-copy-button-to-env-var[]
-Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_HIGHLIGHT_SQL+++`
-endif::add-copy-button-to-env-var[]
---|boolean 
-|`true`
-
-
-a| [[quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-log_quarkus-hibernate-orm-log-jdbc-warnings]]`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-log_quarkus-hibernate-orm-log-jdbc-warnings[quarkus.hibernate-orm.log.jdbc-warnings]`
-
-`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-log_quarkus-hibernate-orm-log-jdbc-warnings[quarkus.hibernate-orm."persistence-unit-name".log.jdbc-warnings]`
-
-
-[.description]
---
-Whether JDBC warnings should be collected and logged.
-
-ifdef::add-copy-button-to-env-var[]
-Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_LOG_JDBC_WARNINGS+++[]
-endif::add-copy-button-to-env-var[]
-ifndef::add-copy-button-to-env-var[]
-Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_JDBC_WARNINGS+++`
-endif::add-copy-button-to-env-var[]
---|boolean 
-|`depends on dialect`
-
-
-a| [[quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-log_quarkus-hibernate-orm-log-queries-slower-than-ms]]`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-log_quarkus-hibernate-orm-log-queries-slower-than-ms[quarkus.hibernate-orm.log.queries-slower-than-ms]`
-
-`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-log_quarkus-hibernate-orm-log-queries-slower-than-ms[quarkus.hibernate-orm."persistence-unit-name".log.queries-slower-than-ms]`
-
-
-[.description]
---
-If set, Hibernate will log queries that took more than specified number of milliseconds to execute.
-
-ifdef::add-copy-button-to-env-var[]
-Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_LOG_QUERIES_SLOWER_THAN_MS+++[]
-endif::add-copy-button-to-env-var[]
-ifndef::add-copy-button-to-env-var[]
-Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_QUERIES_SLOWER_THAN_MS+++`
-endif::add-copy-button-to-env-var[]
---|long 
-|
-
 |===