Skip to content

Commit 8de6450

Browse files
committed
Sync documentation of main branch
1 parent 96f73b5 commit 8de6450

File tree

6 files changed

+18
-93
lines changed

6 files changed

+18
-93
lines changed

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

Lines changed: 0 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -9378,44 +9378,6 @@ endif::add-copy-button-to-env-var[]
93789378
|list of string
93799379
|
93809380

9381-
a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-resources-excludes]] [.property-path]##link:#quarkus-core_quarkus-native-resources-excludes[`quarkus.native.resources.excludes`]##
9382-
ifdef::add-copy-button-to-config-props[]
9383-
config_property_copy_button:+++quarkus.native.resources.excludes+++[]
9384-
endif::add-copy-button-to-config-props[]
9385-
9386-
9387-
[.description]
9388-
--
9389-
A comma separated list of globs to match resource paths that should *not* be added to the native image.
9390-
9391-
Use slash (`/`) as a path separator on all platforms. Globs must not start with slash.
9392-
9393-
Please refer to `includes` for details about the glob syntax.
9394-
9395-
By default, no resources are excluded.
9396-
9397-
Example: Given that you have `src/main/resources/red.png` and `src/main/resources/foo/green.png` in your source tree and one of your dependency JARs contains `bar/blue.png` file, with the following configuration
9398-
9399-
```
9400-
quarkus.native.resources.includes = **/*.png
9401-
quarkus.native.resources.excludes = foo/**,**/green.png
9402-
```
9403-
9404-
9405-
9406-
the resource `red.png` will be available in the native image while the resources `foo/green.png` and `bar/blue.png` will not be available in the native image.
9407-
9408-
9409-
ifdef::add-copy-button-to-env-var[]
9410-
Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_RESOURCES_EXCLUDES+++[]
9411-
endif::add-copy-button-to-env-var[]
9412-
ifndef::add-copy-button-to-env-var[]
9413-
Environment variable: `+++QUARKUS_NATIVE_RESOURCES_EXCLUDES+++`
9414-
endif::add-copy-button-to-env-var[]
9415-
--
9416-
|list of string
9417-
|
9418-
94199381
a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-debug-enabled]] [.property-path]##link:#quarkus-core_quarkus-native-debug-enabled[`quarkus.native.debug.enabled`]##
94209382
ifdef::add-copy-button-to-config-props[]
94219383
config_property_copy_button:+++quarkus.native.debug.enabled+++[]

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

Lines changed: 0 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -773,44 +773,6 @@ endif::add-copy-button-to-env-var[]
773773
|list of string
774774
|
775775

776-
a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-resources-excludes]] [.property-path]##link:#quarkus-core_quarkus-native-resources-excludes[`quarkus.native.resources.excludes`]##
777-
ifdef::add-copy-button-to-config-props[]
778-
config_property_copy_button:+++quarkus.native.resources.excludes+++[]
779-
endif::add-copy-button-to-config-props[]
780-
781-
782-
[.description]
783-
--
784-
A comma separated list of globs to match resource paths that should *not* be added to the native image.
785-
786-
Use slash (`/`) as a path separator on all platforms. Globs must not start with slash.
787-
788-
Please refer to `includes` for details about the glob syntax.
789-
790-
By default, no resources are excluded.
791-
792-
Example: Given that you have `src/main/resources/red.png` and `src/main/resources/foo/green.png` in your source tree and one of your dependency JARs contains `bar/blue.png` file, with the following configuration
793-
794-
```
795-
quarkus.native.resources.includes = **/*.png
796-
quarkus.native.resources.excludes = foo/**,**/green.png
797-
```
798-
799-
800-
801-
the resource `red.png` will be available in the native image while the resources `foo/green.png` and `bar/blue.png` will not be available in the native image.
802-
803-
804-
ifdef::add-copy-button-to-env-var[]
805-
Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_RESOURCES_EXCLUDES+++[]
806-
endif::add-copy-button-to-env-var[]
807-
ifndef::add-copy-button-to-env-var[]
808-
Environment variable: `+++QUARKUS_NATIVE_RESOURCES_EXCLUDES+++`
809-
endif::add-copy-button-to-env-var[]
810-
--
811-
|list of string
812-
|
813-
814776
a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-debug-enabled]] [.property-path]##link:#quarkus-core_quarkus-native-debug-enabled[`quarkus.native.debug.enabled`]##
815777
ifdef::add-copy-button-to-config-props[]
816778
config_property_copy_button:+++quarkus.native.debug.enabled+++[]

_generated-doc/main/infra/quarkus-all-build-items.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7136,6 +7136,10 @@ _No Javadoc found_
71367136

71377137
_No Javadoc found_
71387138

7139+
`java.net.URI source`
7140+
7141+
_No Javadoc found_
7142+
71397143

71407144

71417145

_versions/main/guides/logging.adoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -497,7 +497,7 @@ Log file rotation ensures efficient log management by preserving a specified num
497497
+
498498
[source, properties]
499499
----
500-
quarkus.log.file.enable=true
500+
quarkus.log.file.enabled=true
501501
quarkus.log.file.path=application.log
502502
quarkus.log.file.format=%d{yyyy-MM-dd HH:mm:ss} %-5p [%c] (%t) %s%e%n
503503
----
@@ -506,7 +506,7 @@ quarkus.log.file.format=%d{yyyy-MM-dd HH:mm:ss} %-5p [%c] (%t) %s%e%n
506506
+
507507
[source, properties]
508508
----
509-
quarkus.log.handler.file.my-file-handler.enable=true
509+
quarkus.log.handler.file.my-file-handler.enabled=true
510510
quarkus.log.handler.file.my-file-handler.path=application.log
511511
quarkus.log.handler.file.my-file-handler.format=%d{yyyy-MM-dd HH:mm:ss} [com.example] %s%e%n
512512
@@ -529,7 +529,7 @@ When enabled, it sends all log events to a syslog server, typically the local sy
529529
+
530530
[source, properties]
531531
----
532-
quarkus.log.syslog.enable=true
532+
quarkus.log.syslog.enabled=true
533533
quarkus.log.syslog.app-name=my-application
534534
quarkus.log.syslog.format=%d{yyyy-MM-dd HH:mm:ss} %-5p [%c] (%t) %s%e%n
535535
----
@@ -538,7 +538,7 @@ quarkus.log.syslog.format=%d{yyyy-MM-dd HH:mm:ss} %-5p [%c] (%t) %s%e%n
538538
+
539539
[source, properties]
540540
----
541-
quarkus.log.handler.syslog.my-syslog-handler.enable=true
541+
quarkus.log.handler.syslog.my-syslog-handler.enabled=true
542542
quarkus.log.handler.syslog.my-syslog-handler.app-name=my-application
543543
quarkus.log.handler.syslog.my-syslog-handler.format=%d{yyyy-MM-dd HH:mm:ss} [com.example] %s%e%n
544544
@@ -559,7 +559,7 @@ When enabled, it sends all log events to a socket, such as a Logstash server.
559559
+
560560
[source, properties]
561561
----
562-
quarkus.log.socket.enable=true
562+
quarkus.log.socket.enabled=true
563563
quarkus.log.socket.endpoint=localhost:4560
564564
----
565565

@@ -641,7 +641,7 @@ For example, `-Dquarkus.log.category.\"io.quarkus\".level=DEBUG`.
641641
.File TRACE logging configuration
642642
[source, properties]
643643
----
644-
quarkus.log.file.enable=true
644+
quarkus.log.file.enabled=true
645645
# Send output to a trace.log file under the /tmp directory
646646
quarkus.log.file.path=/tmp/trace.log
647647
quarkus.log.file.level=TRACE
@@ -664,7 +664,7 @@ quarkus.log.console.format=%d{HH:mm:ss} %-5p [%c{2.}] (%t) %s%e%n
664664
# Configure a named handler that logs to console
665665
quarkus.log.handler.console."STRUCTURED_LOGGING".format=%e%n
666666
# Configure a named handler that logs to file
667-
quarkus.log.handler.file."STRUCTURED_LOGGING_FILE".enable=true
667+
quarkus.log.handler.file."STRUCTURED_LOGGING_FILE".enabled=true
668668
quarkus.log.handler.file."STRUCTURED_LOGGING_FILE".format=%e%n
669669
# Configure the category and link the two named handlers to it
670670
quarkus.log.category."io.quarkus.category".level=INFO
@@ -676,7 +676,7 @@ quarkus.log.category."io.quarkus.category".handlers=STRUCTURED_LOGGING,STRUCTURE
676676
[source, properties]
677677
----
678678
# configure a named file handler that sends the output to 'quarkus.log'
679-
quarkus.log.handler.file.CONSOLE_MIRROR.enable=true
679+
quarkus.log.handler.file.CONSOLE_MIRROR.enabled=true
680680
quarkus.log.handler.file.CONSOLE_MIRROR.path=quarkus.log
681681
# attach the handler to the root logger
682682
quarkus.log.handlers=CONSOLE_MIRROR

_versions/main/guides/rest-client.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ import jakarta.ws.rs.QueryParam;
157157
import jakarta.ws.rs.core.MultivaluedMap;
158158
import java.util.Map;
159159
import java.util.Set;
160-
import java util.Optional;
160+
import java.util.Optional;
161161
162162
@Path("/extensions")
163163
@RegisterRestClient(configKey = "extensions-api")
@@ -466,7 +466,7 @@ The name of the property needs to follow a certain convention which is best disp
466466
[source,properties]
467467
----
468468
# Your configuration properties
469-
quarkus.rest-client."org.acme.rest.client.ExtensionsService".url=https://stage.code.quarkus.io/api # // <1>
469+
quarkus.rest-client."org.acme.rest.client.ExtensionsService".url=https://stage.code.quarkus.io/api // <1>
470470
----
471471

472472
<1> Having this configuration means that all requests performed using `org.acme.rest.client.ExtensionsService` will use `https://stage.code.quarkus.io/api` as the base URL.

_versions/main/guides/writing-native-applications-tips.adoc

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -39,22 +39,19 @@ Other resources should be declared explicitly.
3939

4040
==== Using the `quarkus.native.resources.includes` configuration property
4141

42-
To include more resources in the native executable, the easiest way is to use the `quarkus.native.resources.includes` configuration property,
43-
and its counterpart to exclude resources `quarkus.native.resources.excludes`.
42+
To include more resources in the native executable, the easiest way is to use the `quarkus.native.resources.includes` configuration property.
43+
The configuration property supports glob patterns.
4444

45-
Both configuration properties support glob patterns.
46-
47-
For instance, having the following properties in your `application.properties`:
45+
For instance, having the following property in your `application.properties`:
4846

4947
[source,properties]
5048
----
5149
quarkus.native.resources.includes=foo/**,bar/**/*.txt
52-
quarkus.native.resources.excludes=foo/private/**
5350
----
5451

5552
will include:
5653

57-
* all files in the `foo/` directory and its subdirectories except for files in `foo/private/` and its subdirectories,
54+
* all files in the `foo/` directory and its subdirectories,
5855
* all text files in the `bar/` directory and its subdirectories.
5956

6057
==== Using a configuration file

0 commit comments

Comments
 (0)