Skip to content

Commit

Permalink
Sync documentation of main branch
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Nov 26, 2024
1 parent aaf3742 commit 1bc68db
Show file tree
Hide file tree
Showing 22 changed files with 381 additions and 48 deletions.
185 changes: 170 additions & 15 deletions _generated-doc/main/config/quarkus-all-config.adoc

Large diffs are not rendered by default.

14 changes: 11 additions & 3 deletions _generated-doc/main/config/quarkus-arc.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ endif::add-copy-button-to-config-props[]
- If set to `none` (or `false`) no beans will ever be removed even if they are unused (according to the criteria set out below)
- If set to `fwk`, then all unused beans will be removed, except the unused beans whose classes are declared in the application code



An unused bean:

- is not a built-in bean or interceptor,
Expand Down Expand Up @@ -143,7 +145,9 @@ An element value can be:
- a fully qualified class name, i.e. `org.acme.Foo`
- a simple class name as defined by `Class++#++getSimpleName()`, i.e. `Foo`
- a package name with suffix `.++*++`, i.e. `org.acme.++*++`, matches a package
- 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.
- 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.


ifdef::add-copy-button-to-env-var[]
Expand Down Expand Up @@ -192,7 +196,9 @@ An element value can be:
- a fully qualified class name, i.e. `org.acme.Foo`
- a simple class name as defined by `Class++#++getSimpleName()`, i.e. `Foo`
- a package name with suffix `.++*++`, i.e. `org.acme.++*++`, matches a package
- 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.
- 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.


ifdef::add-copy-button-to-env-var[]
Expand Down Expand Up @@ -220,7 +226,9 @@ An element value can be:
- a fully qualified class name, i.e. `org.acme.Foo`
- a simple class name as defined by `Class++#++getSimpleName()`, i.e. `Foo`
- a package name with suffix `.++*++`, i.e. `org.acme.++*++`, matches a package
- 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.
- 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.


ifdef::add-copy-button-to-env-var[]
Expand Down
14 changes: 11 additions & 3 deletions _generated-doc/main/config/quarkus-arc_quarkus.arc.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ endif::add-copy-button-to-config-props[]
- If set to `none` (or `false`) no beans will ever be removed even if they are unused (according to the criteria set out below)
- If set to `fwk`, then all unused beans will be removed, except the unused beans whose classes are declared in the application code



An unused bean:

- is not a built-in bean or interceptor,
Expand Down Expand Up @@ -143,7 +145,9 @@ An element value can be:
- a fully qualified class name, i.e. `org.acme.Foo`
- a simple class name as defined by `Class++#++getSimpleName()`, i.e. `Foo`
- a package name with suffix `.++*++`, i.e. `org.acme.++*++`, matches a package
- 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.
- 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.


ifdef::add-copy-button-to-env-var[]
Expand Down Expand Up @@ -192,7 +196,9 @@ An element value can be:
- a fully qualified class name, i.e. `org.acme.Foo`
- a simple class name as defined by `Class++#++getSimpleName()`, i.e. `Foo`
- a package name with suffix `.++*++`, i.e. `org.acme.++*++`, matches a package
- 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.
- 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.


ifdef::add-copy-button-to-env-var[]
Expand Down Expand Up @@ -220,7 +226,9 @@ An element value can be:
- a fully qualified class name, i.e. `org.acme.Foo`
- a simple class name as defined by `Class++#++getSimpleName()`, i.e. `Foo`
- a package name with suffix `.++*++`, i.e. `org.acme.++*++`, matches a package
- 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.
- 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.


ifdef::add-copy-button-to-env-var[]
Expand Down
6 changes: 5 additions & 1 deletion _generated-doc/main/config/quarkus-azure-functions.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,11 @@ Description of each type can be found link:https://github.com/microsoft/azure-ma
- *key* Password for _service_principal_ if using password authentication
- *certificate* Path to PEM file if using _service_principal_
- *certificate-password* Password for PEM file if it is password protected and if using _service_principal_
- *environment* if using _service_principal_ Defaults to "azure_cli" for authentication
- *environment* if using _service_principal_



Defaults to "azure_cli" for authentication


ifdef::add-copy-button-to-env-var[]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,11 @@ Description of each type can be found link:https://github.com/microsoft/azure-ma
- *key* Password for _service_principal_ if using password authentication
- *certificate* Path to PEM file if using _service_principal_
- *certificate-password* Password for PEM file if it is password protected and if using _service_principal_
- *environment* if using _service_principal_ Defaults to "azure_cli" for authentication
- *environment* if using _service_principal_



Defaults to "azure_cli" for authentication


ifdef::add-copy-button-to-env-var[]
Expand Down
8 changes: 6 additions & 2 deletions _generated-doc/main/config/quarkus-container-image-jib.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,9 @@ If this is set, then it will be used as the entry point of the container image.
- Entrypoint "INHERIT" means to inherit entrypoint from base image, `jvmArguments` field is used for arguments
- A valid entrypoint is jar package specific (see `quarkus.package.jar.type`)
- 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.
- 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]
- 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]


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

- Entrypoint "INHERIT" means to inherit entrypoint from base image, `nativeArguments` field is used for arguments
- 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
- 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]
- 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]


ifdef::add-copy-button-to-env-var[]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,9 @@ If this is set, then it will be used as the entry point of the container image.
- Entrypoint "INHERIT" means to inherit entrypoint from base image, `jvmArguments` field is used for arguments
- A valid entrypoint is jar package specific (see `quarkus.package.jar.type`)
- 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.
- 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]
- 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]


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

- Entrypoint "INHERIT" means to inherit entrypoint from base image, `nativeArguments` field is used for arguments
- 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
- 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]
- 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]


ifdef::add-copy-button-to-env-var[]
Expand Down
40 changes: 37 additions & 3 deletions _generated-doc/main/config/quarkus-core_quarkus.native.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -677,13 +677,47 @@ quarkus.native.resources.includes = foo/**,bar/**/*.txt

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.

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
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
!===


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

. `application.properties` parser
- MicroProfile Config list converter that splits the comma separated list
- 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.
. MicroProfile Config list converter that splits the comma separated list
. 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.

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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,9 @@ Specify the dependencies that are allowed to have proto files that can be import

- _none_ - default - don't scan dependencies
- a comma separated list of _groupId:artifactId_ coordinates to scan
- _all_ - scan all dependencies By default, _com.google.protobuf:protobuf-java_.
- _all_ - scan all dependencies

By default, _com.google.protobuf:protobuf-java_.


ifdef::add-copy-button-to-env-var[]
Expand Down
4 changes: 3 additions & 1 deletion _generated-doc/main/config/quarkus-qute.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,9 @@ A valid prefix consists of alphanumeric characters and underscores. Three specia

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

By default, the `<alias_>` constant is set.


ifdef::add-copy-button-to-env-var[]
Expand Down
4 changes: 3 additions & 1 deletion _generated-doc/main/config/quarkus-qute_quarkus.qute.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,9 @@ A valid prefix consists of alphanumeric characters and underscores. Three specia

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

By default, the `<alias_>` constant is set.


ifdef::add-copy-button-to-env-var[]
Expand Down
4 changes: 3 additions & 1 deletion _generated-doc/main/config/quarkus-rest-client-config.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -767,7 +767,9 @@ The possible values are:

- `request-response` - enables logging request and responses, including redirect responses
- `all` - enables logging requests and responses and lower-level logging
- `none` - no additional logging This property is applicable to reactive REST clients only.
- `none` - no additional logging

This property is applicable to reactive REST clients only.


ifdef::add-copy-button-to-env-var[]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -767,7 +767,9 @@ The possible values are:

- `request-response` - enables logging request and responses, including redirect responses
- `all` - enables logging requests and responses and lower-level logging
- `none` - no additional logging This property is applicable to reactive REST clients only.
- `none` - no additional logging

This property is applicable to reactive REST clients only.


ifdef::add-copy-button-to-env-var[]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -286,7 +286,7 @@ Specifies the `JsonNamingStrategy` that should be used for all properties in cla
This element can be one of two things:

. the fully qualified class name of a type implements the `NamingStrategy` interface and has a no-arg constructor
- a value in the form `NamingStrategy.SnakeCase` which refers to built-in values provided by the kotlin serialization library itself.
. a value in the form `NamingStrategy.SnakeCase` which refers to built-in values provided by the kotlin serialization library itself.


ifdef::add-copy-button-to-env-var[]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -286,7 +286,7 @@ Specifies the `JsonNamingStrategy` that should be used for all properties in cla
This element can be one of two things:

. the fully qualified class name of a type implements the `NamingStrategy` interface and has a no-arg constructor
- a value in the form `NamingStrategy.SnakeCase` which refers to built-in values provided by the kotlin serialization library itself.
. a value in the form `NamingStrategy.SnakeCase` which refers to built-in values provided by the kotlin serialization library itself.


ifdef::add-copy-button-to-env-var[]
Expand Down
4 changes: 3 additions & 1 deletion _generated-doc/main/config/quarkus-security-webauthn.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,9 @@ endif::add-copy-button-to-config-props[]
Kind of Authenticator Attachment allowed. Authenticators can connect to your device in two forms:

- `PLATFORM` - The Authenticator is built-in to your device (e.g.: Security chip)
- `CROSS_PLATFORM` - The Authenticator can roam across devices (e.g.: USB Authenticator) For security reasons your application may choose to restrict to a specific attachment mode. If omitted, then any mode is permitted.
- `CROSS_PLATFORM` - The Authenticator can roam across devices (e.g.: USB Authenticator)

For security reasons your application may choose to restrict to a specific attachment mode. If omitted, then any mode is permitted.


ifdef::add-copy-button-to-env-var[]
Expand Down
Loading

0 comments on commit 1bc68db

Please sign in to comment.