Mention 'BuildLayout' in section on available services

gradle · Nov 28, 2023 · 14cd301 · 14cd301
1 parent a26cec5
commit 14cd301
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/subprojects/docs/src/docs/userguide/extending-gradle/custom_gradle_types.adoc b/subprojects/docs/src/docs/userguide/extending-gradle/custom_gradle_types.adoc
@@ -181,6 +181,7 @@ The following services are available for injection:
 
 - link:{javadocPath}/org/gradle/api/model/ObjectFactory.html[ObjectFactory] - Allows model objects to be created. See <<#nested_objects>> for more details.
 - link:{groovyDslPath}/org.gradle.api.file.ProjectLayout.html[ProjectLayout] - Provides access to key project locations. See <<lazy_configuration.adoc#working_with_files_in_lazy_properties,lazy configuration>> for more details. This service is unavailable in Worker API actions.
+- link:{groovyDslPath}/org.gradle.api.file.BuildLayout.html[BuildLayout] - Provides access to important locations for a Gradle build. This service is only available for injection in settings plugins.
 - link:{groovyDslPath}/org.gradle.api.provider.ProviderFactory.html[ProviderFactory] - Creates `Provider` instances. See <<lazy_configuration.adoc#lazy_configuration,lazy configuration>> for more details.
 - link:{javadocPath}/org/gradle/workers/WorkerExecutor.html[WorkerExecutor] - Allows a task to run work in parallel. See <<custom_tasks.adoc#worker_api,the worker API>> for more details.
 - link:{javadocPath}/org/gradle/api/file/FileSystemOperations.html[FileSystemOperations] - Allows a task to run operations on the filesystem such as deleting files, copying files or syncing directories.