Skip to content

Commit 1bc68db

Browse files
committed
Sync documentation of main branch
1 parent aaf3742 commit 1bc68db

22 files changed

+381
-48
lines changed

_generated-doc/main/config/quarkus-all-config.adoc

Lines changed: 170 additions & 15 deletions
Large diffs are not rendered by default.

_generated-doc/main/config/quarkus-arc.adoc

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ endif::add-copy-button-to-config-props[]
1919
- If set to `none` (or `false`) no beans will ever be removed even if they are unused (according to the criteria set out below)
2020
- If set to `fwk`, then all unused beans will be removed, except the unused beans whose classes are declared in the application code
2121

22+
23+
2224
An unused bean:
2325

2426
- is not a built-in bean or interceptor,
@@ -143,7 +145,9 @@ An element value can be:
143145
- a fully qualified class name, i.e. `org.acme.Foo`
144146
- a simple class name as defined by `Class++#++getSimpleName()`, i.e. `Foo`
145147
- a package name with suffix `.++*++`, i.e. `org.acme.++*++`, matches a package
146-
- a package name with suffix `.++**++`, i.e. `org.acme.++**++`, matches a package that starts with the value Each element value is used to match an alternative bean class, an alternative stereotype annotation type or a bean class that declares an alternative producer. If any value matches then the priority of `Integer++#++MAX_VALUE` is used for the relevant bean. The priority declared via `jakarta.annotation.Priority` is overridden.
148+
- a package name with suffix `.++**++`, i.e. `org.acme.++**++`, matches a package that starts with the value
149+
150+
Each element value is used to match an alternative bean class, an alternative stereotype annotation type or a bean class that declares an alternative producer. If any value matches then the priority of `Integer++#++MAX_VALUE` is used for the relevant bean. The priority declared via `jakarta.annotation.Priority` is overridden.
147151

148152

149153
ifdef::add-copy-button-to-env-var[]
@@ -192,7 +196,9 @@ An element value can be:
192196
- a fully qualified class name, i.e. `org.acme.Foo`
193197
- a simple class name as defined by `Class++#++getSimpleName()`, i.e. `Foo`
194198
- a package name with suffix `.++*++`, i.e. `org.acme.++*++`, matches a package
195-
- a package name with suffix `.++**++`, i.e. `org.acme.++**++`, matches a package that starts with the value If any element value matches a discovered type then the type is excluded from discovery, i.e. no beans and observer methods are created from this type.
199+
- a package name with suffix `.++**++`, i.e. `org.acme.++**++`, matches a package that starts with the value
200+
201+
If any element value matches a discovered type then the type is excluded from discovery, i.e. no beans and observer methods are created from this type.
196202

197203

198204
ifdef::add-copy-button-to-env-var[]
@@ -220,7 +226,9 @@ An element value can be:
220226
- a fully qualified class name, i.e. `org.acme.Foo`
221227
- a simple class name as defined by `Class++#++getSimpleName()`, i.e. `Foo`
222228
- a package name with suffix `.++*++`, i.e. `org.acme.++*++`, matches a package
223-
- a package name with suffix `.++**++`, i.e. `org.acme.++**++`, matches a package that starts with the value If any element value matches a discovered bean, then such a bean is considered unremovable.
229+
- a package name with suffix `.++**++`, i.e. `org.acme.++**++`, matches a package that starts with the value
230+
231+
If any element value matches a discovered bean, then such a bean is considered unremovable.
224232

225233

226234
ifdef::add-copy-button-to-env-var[]

_generated-doc/main/config/quarkus-arc_quarkus.arc.adoc

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ endif::add-copy-button-to-config-props[]
1919
- If set to `none` (or `false`) no beans will ever be removed even if they are unused (according to the criteria set out below)
2020
- If set to `fwk`, then all unused beans will be removed, except the unused beans whose classes are declared in the application code
2121

22+
23+
2224
An unused bean:
2325

2426
- is not a built-in bean or interceptor,
@@ -143,7 +145,9 @@ An element value can be:
143145
- a fully qualified class name, i.e. `org.acme.Foo`
144146
- a simple class name as defined by `Class++#++getSimpleName()`, i.e. `Foo`
145147
- a package name with suffix `.++*++`, i.e. `org.acme.++*++`, matches a package
146-
- a package name with suffix `.++**++`, i.e. `org.acme.++**++`, matches a package that starts with the value Each element value is used to match an alternative bean class, an alternative stereotype annotation type or a bean class that declares an alternative producer. If any value matches then the priority of `Integer++#++MAX_VALUE` is used for the relevant bean. The priority declared via `jakarta.annotation.Priority` is overridden.
148+
- a package name with suffix `.++**++`, i.e. `org.acme.++**++`, matches a package that starts with the value
149+
150+
Each element value is used to match an alternative bean class, an alternative stereotype annotation type or a bean class that declares an alternative producer. If any value matches then the priority of `Integer++#++MAX_VALUE` is used for the relevant bean. The priority declared via `jakarta.annotation.Priority` is overridden.
147151

148152

149153
ifdef::add-copy-button-to-env-var[]
@@ -192,7 +196,9 @@ An element value can be:
192196
- a fully qualified class name, i.e. `org.acme.Foo`
193197
- a simple class name as defined by `Class++#++getSimpleName()`, i.e. `Foo`
194198
- a package name with suffix `.++*++`, i.e. `org.acme.++*++`, matches a package
195-
- a package name with suffix `.++**++`, i.e. `org.acme.++**++`, matches a package that starts with the value If any element value matches a discovered type then the type is excluded from discovery, i.e. no beans and observer methods are created from this type.
199+
- a package name with suffix `.++**++`, i.e. `org.acme.++**++`, matches a package that starts with the value
200+
201+
If any element value matches a discovered type then the type is excluded from discovery, i.e. no beans and observer methods are created from this type.
196202

197203

198204
ifdef::add-copy-button-to-env-var[]
@@ -220,7 +226,9 @@ An element value can be:
220226
- a fully qualified class name, i.e. `org.acme.Foo`
221227
- a simple class name as defined by `Class++#++getSimpleName()`, i.e. `Foo`
222228
- a package name with suffix `.++*++`, i.e. `org.acme.++*++`, matches a package
223-
- a package name with suffix `.++**++`, i.e. `org.acme.++**++`, matches a package that starts with the value If any element value matches a discovered bean, then such a bean is considered unremovable.
229+
- a package name with suffix `.++**++`, i.e. `org.acme.++**++`, matches a package that starts with the value
230+
231+
If any element value matches a discovered bean, then such a bean is considered unremovable.
224232

225233

226234
ifdef::add-copy-button-to-env-var[]

_generated-doc/main/config/quarkus-azure-functions.adoc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,11 @@ Description of each type can be found link:https://github.com/microsoft/azure-ma
218218
- *key* Password for _service_principal_ if using password authentication
219219
- *certificate* Path to PEM file if using _service_principal_
220220
- *certificate-password* Password for PEM file if it is password protected and if using _service_principal_
221-
- *environment* if using _service_principal_ Defaults to "azure_cli" for authentication
221+
- *environment* if using _service_principal_
222+
223+
224+
225+
Defaults to "azure_cli" for authentication
222226

223227

224228
ifdef::add-copy-button-to-env-var[]

_generated-doc/main/config/quarkus-azure-functions_quarkus.azure-functions.adoc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,11 @@ Description of each type can be found link:https://github.com/microsoft/azure-ma
218218
- *key* Password for _service_principal_ if using password authentication
219219
- *certificate* Path to PEM file if using _service_principal_
220220
- *certificate-password* Password for PEM file if it is password protected and if using _service_principal_
221-
- *environment* if using _service_principal_ Defaults to "azure_cli" for authentication
221+
- *environment* if using _service_principal_
222+
223+
224+
225+
Defaults to "azure_cli" for authentication
222226

223227

224228
ifdef::add-copy-button-to-env-var[]

_generated-doc/main/config/quarkus-container-image-jib.adoc

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,9 @@ If this is set, then it will be used as the entry point of the container image.
125125
- Entrypoint "INHERIT" means to inherit entrypoint from base image, `jvmArguments` field is used for arguments
126126
- A valid entrypoint is jar package specific (see `quarkus.package.jar.type`)
127127
- A valid entrypoint depends on the location of both the launching scripts and the application jar file. To that end it's helpful to remember that when `fast-jar` packaging is used (the default), all necessary application jars are added to the `/work` directory and that the same directory is also used as the working directory. When `legacy-jar` or `uber-jar` are used, the application jars are unpacked under the `/app` directory and that directory is used as the working directory.
128-
- Even if the `jvmArguments` field is set, it is ignored completely unless entrypoint is "INHERIT" When this is not set, a proper default entrypoint will be constructed. As a final note, a very useful tool for inspecting container image layers that can greatly aid when debugging problems with endpoints is link:https://github.com/wagoodman/dive[dive]
128+
- Even if the `jvmArguments` field is set, it is ignored completely unless entrypoint is "INHERIT"
129+
130+
When this is not set, a proper default entrypoint will be constructed. As a final note, a very useful tool for inspecting container image layers that can greatly aid when debugging problems with endpoints is link:https://github.com/wagoodman/dive[dive]
129131

130132

131133
ifdef::add-copy-button-to-env-var[]
@@ -150,7 +152,9 @@ If this is set, then it will be used as the entry point of the container image.
150152

151153
- Entrypoint "INHERIT" means to inherit entrypoint from base image, `nativeArguments` field is used for arguments
152154
- A valid entrypoint depends on the location of both the launching scripts and the native binary file. To that end it's helpful to remember that the native application is added to the `/work` directory and that and the same directory is also used as the working directory
153-
- Even if the `nativeArguments` field is set, it is ignored completely unless entrypoint is "INHERIT" When this is not set, a proper default entrypoint will be constructed. As a final note, a very useful tool for inspecting container image layers that can greatly aid when debugging problems with endpoints is link:https://github.com/wagoodman/dive[dive]
155+
- Even if the `nativeArguments` field is set, it is ignored completely unless entrypoint is "INHERIT"
156+
157+
When this is not set, a proper default entrypoint will be constructed. As a final note, a very useful tool for inspecting container image layers that can greatly aid when debugging problems with endpoints is link:https://github.com/wagoodman/dive[dive]
154158

155159

156160
ifdef::add-copy-button-to-env-var[]

_generated-doc/main/config/quarkus-container-image-jib_quarkus.jib.adoc

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,9 @@ If this is set, then it will be used as the entry point of the container image.
125125
- Entrypoint "INHERIT" means to inherit entrypoint from base image, `jvmArguments` field is used for arguments
126126
- A valid entrypoint is jar package specific (see `quarkus.package.jar.type`)
127127
- A valid entrypoint depends on the location of both the launching scripts and the application jar file. To that end it's helpful to remember that when `fast-jar` packaging is used (the default), all necessary application jars are added to the `/work` directory and that the same directory is also used as the working directory. When `legacy-jar` or `uber-jar` are used, the application jars are unpacked under the `/app` directory and that directory is used as the working directory.
128-
- Even if the `jvmArguments` field is set, it is ignored completely unless entrypoint is "INHERIT" When this is not set, a proper default entrypoint will be constructed. As a final note, a very useful tool for inspecting container image layers that can greatly aid when debugging problems with endpoints is link:https://github.com/wagoodman/dive[dive]
128+
- Even if the `jvmArguments` field is set, it is ignored completely unless entrypoint is "INHERIT"
129+
130+
When this is not set, a proper default entrypoint will be constructed. As a final note, a very useful tool for inspecting container image layers that can greatly aid when debugging problems with endpoints is link:https://github.com/wagoodman/dive[dive]
129131

130132

131133
ifdef::add-copy-button-to-env-var[]
@@ -150,7 +152,9 @@ If this is set, then it will be used as the entry point of the container image.
150152

151153
- Entrypoint "INHERIT" means to inherit entrypoint from base image, `nativeArguments` field is used for arguments
152154
- A valid entrypoint depends on the location of both the launching scripts and the native binary file. To that end it's helpful to remember that the native application is added to the `/work` directory and that and the same directory is also used as the working directory
153-
- Even if the `nativeArguments` field is set, it is ignored completely unless entrypoint is "INHERIT" When this is not set, a proper default entrypoint will be constructed. As a final note, a very useful tool for inspecting container image layers that can greatly aid when debugging problems with endpoints is link:https://github.com/wagoodman/dive[dive]
155+
- Even if the `nativeArguments` field is set, it is ignored completely unless entrypoint is "INHERIT"
156+
157+
When this is not set, a proper default entrypoint will be constructed. As a final note, a very useful tool for inspecting container image layers that can greatly aid when debugging problems with endpoints is link:https://github.com/wagoodman/dive[dive]
154158

155159

156160
ifdef::add-copy-button-to-env-var[]

_generated-doc/main/config/quarkus-core_quarkus.native.adoc

Lines changed: 37 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -677,13 +677,47 @@ quarkus.native.resources.includes = foo/**,bar/**/*.txt
677677

678678
the files `src/main/resources/foo/selected.png` and `bar/some.txt` will be included in the native image, while `src/main/resources/ignored.png` will not be included.
679679

680-
Supported glob features Feature Description `++*++` Matches a (possibly empty) sequence of characters that does not contain slash (`/`) `++**++` Matches a (possibly empty) sequence of characters that may contain slash (`/`) `?` Matches one character, but not slash `++[++abc++]++` Matches one character given in the bracket, but not slash `++[++a-z++]++` Matches one character from the range given in the bracket, but not slash `++[++!abc++]++` Matches one character not named in the bracket; does not match slash `++[++a-z++]++` Matches one character outside the range given in the bracket; does not match slash `++{++one,two,three++}++` Matches any of the alternating tokens separated by comma; the tokens may contain wildcards, nested alternations and ranges `++\++` The escape character
680+
Supported glob features
681+
682+
!===
683+
!Feature !Description
684+
685+
!`++*++`
686+
!Matches a (possibly empty) sequence of characters that does not contain slash (`/`)
687+
688+
!`++**++`
689+
!Matches a (possibly empty) sequence of characters that may contain slash (`/`)
690+
691+
!`?`
692+
!Matches one character, but not slash
693+
694+
!`++[++abc++]++`
695+
!Matches one character given in the bracket, but not slash
696+
697+
!`++[++a-z++]++`
698+
!Matches one character from the range given in the bracket, but not slash
699+
700+
!`++[++\!abc++]++`
701+
!Matches one character not named in the bracket; does not match slash
702+
703+
!`++[++a-z++]++`
704+
!Matches one character outside the range given in the bracket; does not match slash
705+
706+
!`++{++one,two,three++}++`
707+
!Matches any of the alternating tokens separated by comma; the tokens may contain wildcards, nested alternations and ranges
708+
709+
!`++\++`
710+
!The escape character
711+
!===
712+
681713

682714
Note that there are three levels of escaping when passing this option via `application.properties`:
683715

684716
. `application.properties` parser
685-
- MicroProfile Config list converter that splits the comma separated list
686-
- Glob parser All three levels use backslash (`++\++`) as the escaping character. So you need to use an appropriate number of backslashes depending on which level you want to escape.
717+
. MicroProfile Config list converter that splits the comma separated list
718+
. Glob parser
719+
720+
All three levels use backslash (`++\++`) as the escaping character. So you need to use an appropriate number of backslashes depending on which level you want to escape.
687721

688722
Note that Quarkus extensions typically include the resources they require by themselves. This option is useful in situations when the built-in functionality is not sufficient.
689723

_generated-doc/main/config/quarkus-grpc_quarkus.generate-code.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,9 @@ Specify the dependencies that are allowed to have proto files that can be import
4444

4545
- _none_ - default - don't scan dependencies
4646
- a comma separated list of _groupId:artifactId_ coordinates to scan
47-
- _all_ - scan all dependencies By default, _com.google.protobuf:protobuf-java_.
47+
- _all_ - scan all dependencies
48+
49+
By default, _com.google.protobuf:protobuf-java_.
4850

4951

5052
ifdef::add-copy-button-to-env-var[]

_generated-doc/main/config/quarkus-qute.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,9 @@ A valid prefix consists of alphanumeric characters and underscores. Three specia
119119

120120
- `<alias_>` - the alias of an iterated element suffixed with an underscore is used, e.g. `item_hasNext` and `it_count`
121121
- `<alias?>` - the alias of an iterated element suffixed with a question mark is used, e.g. `item?hasNext` and `it?count`
122-
- `<none>` - no prefix is used, e.g. `hasNext` and `count` By default, the `<alias_>` constant is set.
122+
- `<none>` - no prefix is used, e.g. `hasNext` and `count`
123+
124+
By default, the `<alias_>` constant is set.
123125

124126

125127
ifdef::add-copy-button-to-env-var[]

0 commit comments

Comments
 (0)