diff --git a/docs/src/main/asciidoc/config-reference.adoc b/docs/src/main/asciidoc/config-reference.adoc index d11d95c38d2f4..25c80ee2d1c0f 100644 --- a/docs/src/main/asciidoc/config-reference.adoc +++ b/docs/src/main/asciidoc/config-reference.adoc @@ -370,7 +370,7 @@ Setting `quarkus.profile` to `staging` will activate the `staging` profile. The `io.smallrye.config.SmallRyeConfig#getProfiles` API provides a way to retrieve the active profiles programmatically. ==== -=== Profile aware files +=== Profile-aware files In this case, properties for a specific profile may reside in an `application-{profile}.properties` named file. The previous example may be expressed as: @@ -391,19 +391,22 @@ quarkus.http.test-port=9191 [NOTE] ==== -In this style, the configuration names in the profile aware file do not need to be prefixed with the profile name. +In this style, the configuration names in the profile-aware file do not need to be prefixed with the profile name. -Properties in the profile aware file have priority over profile aware properties defined in the main file. +Properties in the profile-aware file have priority over profile-aware properties defined in the main file. ==== [WARNING] ==== -Do not use profile aware files to set `quarkus.profile` or `quarkus.test.profile`. This will not work because the -profile is required in advance to load the profile aware files. +Do not use profile-aware files to set `quarkus.profile` or `quarkus.test.profile`. This will not work because the +profile is required in advance to load the profile-aware files. +==== -A profile aware file is only loaded if the unprofiled `application.properties` is also available in the same location -and the file extension matches between the files. This is required to keep a consistent loading order and pair all the -resources together. +[IMPORTANT] +==== +An `application.properties` file must exist (even if empty) in the exact location of the profile-aware +(`application-{profile}.properties`) file to be included in the configuration to ensure a consistent order when +loading the files. ==== === Parent Profile @@ -435,8 +438,8 @@ Then [WARNING] ==== -Do not use Profile aware files to set `quarkus.config.profile.parent`. This will not work because the profile is -required in advance to load the profile aware files. +Do not use Profile-aware files to set `quarkus.config.profile.parent`. This will not work because the profile is +required in advance to load the profile-aware files. ==== === Multiple Profiles