Skip to content

Commit 9a71103

Browse files
lucaspotterskygsmet
authored andcommitted
docs: rename 'enable' to 'enabled'
To keep the docs in line with the recent config property names scheme (enable => enabled): https://github.com/quarkusio/quarkus/wiki/Migration-Guide-3.26#enable-enabled-in-configuration-properties-gear-white_check_mark (cherry picked from commit 02a9f9c)
1 parent dfb0ac9 commit 9a71103

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/src/main/asciidoc/writing-extensions.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1136,7 +1136,7 @@ public interface LogConfiguration {
11361136
* Enable logging to a file.
11371137
*/
11381138
@WithDefault("true")
1139-
boolean enable();
1139+
boolean enabled();
11401140
11411141
/**
11421142
* The log format.
@@ -1172,12 +1172,12 @@ public class LoggingProcessor {
11721172
----
11731173

11741174
A configuration property name can be split into segments. For example, a property name like
1175-
`quarkus.log.file.enable` can be split into the following segments:
1175+
`quarkus.log.file.enabled` can be split into the following segments:
11761176

11771177
* `quarkus` - a namespace claimed by Quarkus which is a prefix for `@ConfigMapping` interfaces,
11781178
* `log` - a name segment which corresponds to the prefix set in the interface annotated with `@ConfigMapping`,
11791179
* `file` - a name segment which corresponds to the `file` field in this class,
1180-
* `enable` - a name segment which corresponds to `enable` field in `FileConfig`.
1180+
* `enabled` - a name segment which corresponds to `enabled` field in `FileConfig`.
11811181

11821182
<1> The `@ConfigMapping` annotation indicates that the interface is a configuration mapping, in this case one which
11831183
corresponds to a `quarkus.log` segment.
@@ -1189,7 +1189,7 @@ A corresponding `application.properties` for the above example could be:
11891189

11901190
[source%nowrap,properties]
11911191
----
1192-
quarkus.log.file.enable=true
1192+
quarkus.log.file.enabled=true
11931193
quarkus.log.file.level=DEBUG
11941194
quarkus.log.file.path=/tmp/debug.log
11951195
----

0 commit comments

Comments
 (0)