Skip to content

Commit 6031d04

Browse files
committed
Fix property description of spring.docker.compose.file
Also fixes the casing of 'Docker Compose' so that it's now spelled consistently.
1 parent 5141045 commit 6031d04

28 files changed

+48
-48
lines changed

spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/core/DockerCli.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,8 @@ class DockerCli {
5656
/**
5757
* Create a new {@link DockerCli} instance.
5858
* @param workingDirectory the working directory or {@code null}
59-
* @param composeFile the docker compose file to use
60-
* @param activeProfiles the docker compose profiles to activate
59+
* @param composeFile the Docker Compose file to use
60+
* @param activeProfiles the Docker Compose profiles to activate
6161
*/
6262
DockerCli(File workingDirectory, DockerComposeFile composeFile, Set<String> activeProfiles) {
6363
this.processRunner = new ProcessRunner(workingDirectory);
@@ -112,7 +112,7 @@ private List<String> createCommand(Type type) {
112112

113113
/**
114114
* Return the {@link DockerComposeFile} being used by this CLI instance.
115-
* @return the docker compose file
115+
* @return the Docker Compose file
116116
*/
117117
DockerComposeFile getDockerComposeFile() {
118118
return this.composeFile;
@@ -156,7 +156,7 @@ private List<String> getDockerComposeCommand(ProcessRunner processRunner) {
156156
DockerCliComposeVersionResponse response = DockerJson.deserialize(
157157
processRunner.run("docker", "compose", "version", "--format", "json"),
158158
DockerCliComposeVersionResponse.class);
159-
logger.trace(LogMessage.format("Using docker compose %s", response.version()));
159+
logger.trace(LogMessage.format("Using Docker Compose %s", response.version()));
160160
return List.of("docker", "compose");
161161
}
162162
catch (ProcessExitException ex) {

spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/core/DockerCliComposeVersionResponse.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2012-2023 the original author or authors.
2+
* Copyright 2012-2024 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -19,7 +19,7 @@
1919
/**
2020
* Response from {@code docker compose version}.
2121
*
22-
* @param version docker compose version
22+
* @param version the Docker Compose version
2323
* @author Moritz Halbritter
2424
* @author Andy Wilkinson
2525
* @author Phillip Webb

spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/core/DockerCompose.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ public interface DockerCompose {
118118

119119
/**
120120
* Factory method used to create a {@link DockerCompose} instance.
121-
* @param file the docker compose file
121+
* @param file the Docker Compose file
122122
* @param hostname the hostname used for services or {@code null} if the hostname
123123
* should be deduced
124124
* @param activeProfiles a set of the profiles that should be activated

spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/core/DockerComposeFile.java

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
import org.springframework.util.Assert;
3030

3131
/**
32-
* A reference to a docker compose file (usually named {@code compose.yaml}).
32+
* A reference to a Docker Compose file (usually named {@code compose.yaml}).
3333
*
3434
* @author Moritz Halbritter
3535
* @author Andy Wilkinson
@@ -61,8 +61,8 @@ private static File toCanonicalFile(File file) {
6161
}
6262

6363
/**
64-
* Returns the source docker compose files.
65-
* @return the source docker compose files
64+
* Returns the source Docker Compose files.
65+
* @return the source Docker Compose files
6666
* @since 3.4.0
6767
*/
6868
public List<File> getFiles() {
@@ -95,7 +95,7 @@ public String toString() {
9595
}
9696

9797
/**
98-
* Find the docker compose file by searching in the given working directory. Files are
98+
* Find the Docker Compose file by searching in the given working directory. Files are
9999
* considered in the same order that {@code docker compose} uses, namely:
100100
* <ul>
101101
* <li>{@code compose.yaml}</li>
@@ -105,7 +105,7 @@ public String toString() {
105105
* </ul>
106106
* @param workingDirectory the working directory to search or {@code null} to use the
107107
* current directory
108-
* @return the located file or {@code null} if no docker compose file can be found
108+
* @return the located file or {@code null} if no Docker Compose file can be found
109109
*/
110110
public static DockerComposeFile find(File workingDirectory) {
111111
File base = (workingDirectory != null) ? workingDirectory : new File(".");
@@ -126,7 +126,7 @@ public static DockerComposeFile find(File workingDirectory) {
126126
/**
127127
* Create a new {@link DockerComposeFile} for the given {@link File}.
128128
* @param file the source file
129-
* @return the docker compose file
129+
* @return the Docker Compose file
130130
*/
131131
public static DockerComposeFile of(File file) {
132132
Assert.notNull(file, "File must not be null");
@@ -138,7 +138,7 @@ public static DockerComposeFile of(File file) {
138138
/**
139139
* Creates a new {@link DockerComposeFile} for the given {@link File files}.
140140
* @param files the source files
141-
* @return the docker compose file
141+
* @return the Docker Compose file
142142
* @since 3.4.0
143143
*/
144144
public static DockerComposeFile of(Collection<? extends File> files) {

spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/core/DockerComposeOrigin.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@
1919
import org.springframework.boot.origin.Origin;
2020

2121
/**
22-
* An origin which points to a service defined in docker compose.
22+
* An origin which points to a service defined in Docker Compose.
2323
*
24-
* @param composeFile docker compose file
25-
* @param serviceName name of the docker compose service
24+
* @param composeFile the Docker Compose file
25+
* @param serviceName name of the Docker Compose service
2626
* @author Moritz Halbritter
2727
* @author Andy Wilkinson
2828
* @since 3.1.0

spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/core/RunningService.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2012-2023 the original author or authors.
2+
* Copyright 2012-2024 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -19,7 +19,7 @@
1919
import java.util.Map;
2020

2121
/**
22-
* Provides details of a running docker compose service.
22+
* Provides details of a running Docker Compose service.
2323
*
2424
* @author Moritz Halbritter
2525
* @author Andy Wilkinson

spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/core/package-info.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,6 @@
1515
*/
1616

1717
/**
18-
* Core interfaces and classes for working with docker compose.
18+
* Core interfaces and classes for working with Docker Compose.
1919
*/
2020
package org.springframework.boot.docker.compose.core;

spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/lifecycle/DockerComposeLifecycleManager.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242
import org.springframework.util.CollectionUtils;
4343

4444
/**
45-
* Manages the lifecycle for docker compose services.
45+
* Manages the lifecycle for Docker Compose services.
4646
*
4747
* @author Moritz Halbritter
4848
* @author Andy Wilkinson

spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/lifecycle/DockerComposeProperties.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,12 +42,12 @@ public class DockerComposeProperties {
4242
static final String NAME = "spring.docker.compose";
4343

4444
/**
45-
* Whether docker compose support is enabled.
45+
* Whether Docker Compose support is enabled.
4646
*/
4747
private boolean enabled = true;
4848

4949
/**
50-
* Path to a specific docker compose configuration file.
50+
* Paths to the Docker Compose configuration files.
5151
*/
5252
private final List<File> file = new ArrayList<>();
5353

@@ -138,7 +138,7 @@ static DockerComposeProperties get(Binder binder) {
138138
public static class Start {
139139

140140
/**
141-
* Command used to start docker compose.
141+
* Command used to start Docker Compose.
142142
*/
143143
private StartCommand command = StartCommand.UP;
144144

@@ -230,7 +230,7 @@ String getLogMessage() {
230230
public static class Stop {
231231

232232
/**
233-
* Command used to stop docker compose.
233+
* Command used to stop Docker Compose.
234234
*/
235235
private StopCommand command = StopCommand.STOP;
236236

spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/lifecycle/DockerComposeServicesReadyEvent.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2012-2023 the original author or authors.
2+
* Copyright 2012-2024 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -48,7 +48,7 @@ public ApplicationContext getSource() {
4848
}
4949

5050
/**
51-
* Return the relevant docker compose services that are running.
51+
* Return the relevant Docker Compose services that are running.
5252
* @return the running services
5353
*/
5454
public List<RunningService> getRunningServices() {

spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/service/connection/DockerComposeConnectionSource.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2012-2023 the original author or authors.
2+
* Copyright 2012-2024 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -20,7 +20,7 @@
2020

2121
/**
2222
* Passed to {@link DockerComposeConnectionDetailsFactory} to provide details of the
23-
* {@link RunningService running docker compose service}.
23+
* {@link RunningService running Docker Compose service}.
2424
*
2525
* @author Moritz Halbritter
2626
* @author Andy Wilkinson
@@ -34,14 +34,14 @@ public final class DockerComposeConnectionSource {
3434

3535
/**
3636
* Create a new {@link DockerComposeConnectionSource} instance.
37-
* @param runningService the running docker compose service
37+
* @param runningService the running Docker Compose service
3838
*/
3939
DockerComposeConnectionSource(RunningService runningService) {
4040
this.runningService = runningService;
4141
}
4242

4343
/**
44-
* Return the running docker compose service.
44+
* Return the running Docker Compose service.
4545
* @return the running service
4646
*/
4747
public RunningService getRunningService() {

spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/service/connection/activemq/package-info.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,6 @@
1515
*/
1616

1717
/**
18-
* Auto-configuration for docker compose ActiveMQ service connections.
18+
* Auto-configuration for Docker Compose ActiveMQ service connections.
1919
*/
2020
package org.springframework.boot.docker.compose.service.connection.activemq;

spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/service/connection/cassandra/package-info.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,6 @@
1515
*/
1616

1717
/**
18-
* Auto-configuration for docker compose Cassandra service connections.
18+
* Auto-configuration for Docker Compose Cassandra service connections.
1919
*/
2020
package org.springframework.boot.docker.compose.service.connection.cassandra;

spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/service/connection/elasticsearch/package-info.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,6 @@
1515
*/
1616

1717
/**
18-
* Auto-configuration for docker compose Elasticsearch service connections.
18+
* Auto-configuration for Docker Compose Elasticsearch service connections.
1919
*/
2020
package org.springframework.boot.docker.compose.service.connection.elasticsearch;

spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/service/connection/flyway/package-info.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,6 @@
1515
*/
1616

1717
/**
18-
* Auto-configuration for docker compose Flyway service connections.
18+
* Auto-configuration for Docker Compose Flyway service connections.
1919
*/
2020
package org.springframework.boot.docker.compose.service.connection.flyway;

spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/service/connection/liquibase/package-info.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,6 @@
1515
*/
1616

1717
/**
18-
* Auto-configuration for docker compose Liquibase service connections.
18+
* Auto-configuration for Docker Compose Liquibase service connections.
1919
*/
2020
package org.springframework.boot.docker.compose.service.connection.liquibase;

spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/service/connection/mariadb/package-info.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,6 @@
1515
*/
1616

1717
/**
18-
* Auto-configuration for docker compose MariaDB service connections.
18+
* Auto-configuration for Docker Compose MariaDB service connections.
1919
*/
2020
package org.springframework.boot.docker.compose.service.connection.mariadb;

spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/service/connection/mongo/package-info.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,6 @@
1515
*/
1616

1717
/**
18-
* Auto-configuration for docker compose MongoDB service connections.
18+
* Auto-configuration for Docker Compose MongoDB service connections.
1919
*/
2020
package org.springframework.boot.docker.compose.service.connection.mongo;

spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/service/connection/mysql/package-info.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,6 @@
1515
*/
1616

1717
/**
18-
* Auto-configuration for docker compose MySQL service connections.
18+
* Auto-configuration for Docker Compose MySQL service connections.
1919
*/
2020
package org.springframework.boot.docker.compose.service.connection.mysql;

spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/service/connection/neo4j/package-info.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,6 @@
1515
*/
1616

1717
/**
18-
* Auto-configuration for docker compose Neo4j service connections.
18+
* Auto-configuration for Docker Compose Neo4j service connections.
1919
*/
2020
package org.springframework.boot.docker.compose.service.connection.neo4j;

spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/service/connection/oracle/package-info.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,6 @@
1515
*/
1616

1717
/**
18-
* Auto-configuration for docker compose MySQL service connections.
18+
* Auto-configuration for Docker Compose MySQL service connections.
1919
*/
2020
package org.springframework.boot.docker.compose.service.connection.oracle;

spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/service/connection/otlp/package-info.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,6 @@
1515
*/
1616

1717
/**
18-
* Support for docker compose OpenTelemetry service connections.
18+
* Support for Docker Compose OpenTelemetry service connections.
1919
*/
2020
package org.springframework.boot.docker.compose.service.connection.otlp;

spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/service/connection/postgres/package-info.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,6 @@
1515
*/
1616

1717
/**
18-
* Auto-configuration for docker compose Postgres service connections.
18+
* Auto-configuration for Docker Compose Postgres service connections.
1919
*/
2020
package org.springframework.boot.docker.compose.service.connection.postgres;

spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/service/connection/pulsar/package-info.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,6 @@
1515
*/
1616

1717
/**
18-
* Auto-configuration for docker compose Pulsar service connections.
18+
* Auto-configuration for Docker Compose Pulsar service connections.
1919
*/
2020
package org.springframework.boot.docker.compose.service.connection.pulsar;

spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/service/connection/rabbit/package-info.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,6 @@
1515
*/
1616

1717
/**
18-
* Auto-configuration for docker compose RabbitMQ service connections.
18+
* Auto-configuration for Docker Compose RabbitMQ service connections.
1919
*/
2020
package org.springframework.boot.docker.compose.service.connection.rabbit;

spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/service/connection/redis/package-info.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,6 @@
1515
*/
1616

1717
/**
18-
* Auto-configuration for docker compose Redis service connections.
18+
* Auto-configuration for Docker Compose Redis service connections.
1919
*/
2020
package org.springframework.boot.docker.compose.service.connection.redis;

spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/service/connection/sqlserver/package-info.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,6 @@
1515
*/
1616

1717
/**
18-
* Auto-configuration for docker compose MS SQL Server service connections.
18+
* Auto-configuration for Docker Compose MS SQL Server service connections.
1919
*/
2020
package org.springframework.boot.docker.compose.service.connection.sqlserver;

spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/service/connection/zipkin/package-info.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,6 @@
1515
*/
1616

1717
/**
18-
* Auto-configuration for docker compose Zipkin service connections.
18+
* Auto-configuration for Docker Compose Zipkin service connections.
1919
*/
2020
package org.springframework.boot.docker.compose.service.connection.zipkin;

0 commit comments

Comments
 (0)