Skip to content

Commit 6698af0

Browse files
committed
Replace Starter POM to Starter in the documentation
"Starter POM" is a confusing term as it implies the starter may be a POM while it's actually a jar artifact like any other dependency. To reduce the confusion (especially in the way such starter should be declared in the build), the term Starter POM has been renamed to Starter. Closes spring-projectsgh-5966
1 parent dcf3a56 commit 6698af0

10 files changed

+48
-47
lines changed

README.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ available so you need to build that first since it's not generated by default.
127127
$ ./mvnw clean install -pl spring-boot-tools/spring-boot-maven-plugin -Pdefault,full
128128
----
129129

130-
The documentation also includes auto-generated information about the starter poms. To
130+
The documentation also includes auto-generated information about the starters. To
131131
allow this information to be collected, the starter projects must be built first:
132132

133133
[indent=0]

spring-boot-actuator/README.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ covers the features in more detail.
1010

1111
== Enabling the Actuator
1212
The simplest way to enable the features is to add a dependency to the
13-
`spring-boot-starter-actuator` "`Starter POM`". To add the actuator to a Maven based
14-
project, add the following "`starter`" dependency:
13+
`spring-boot-starter-actuator` '`Starter`'. To add the actuator to a Maven based
14+
project, add the following '`Starter`' dependency:
1515

1616
[source,xml,indent=0]
1717
----

spring-boot-docs/src/main/asciidoc/deployment.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ Javadoc for complete details.
147147

148148
TIP: The http://cloud.spring.io/spring-cloud-connectors/[Spring Cloud Connectors] project
149149
is a better fit for tasks such as configuring a DataSource. Spring Boot includes
150-
auto-configuration support and a `spring-boot-starter-cloud-connectors` starter POM.
150+
auto-configuration support and a `spring-boot-starter-cloud-connectors` starter.
151151

152152

153153

spring-boot-docs/src/main/asciidoc/documentation-overview.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ got you covered>>.
6868
<<using-spring-boot.adoc#using-boot-maven, Maven>> |
6969
<<using-spring-boot.adoc#using-boot-gradle, Gradle>> |
7070
<<using-spring-boot.adoc#using-boot-ant, Ant>> |
71-
<<using-spring-boot.adoc#using-boot-starter-poms, Starter POMs>>
71+
<<using-spring-boot.adoc#using-boot-starter, Starters>>
7272
* *Best practices:*
7373
<<using-spring-boot.adoc#using-boot-structuring-your-code, Code Structure>> |
7474
<<using-spring-boot.adoc#using-boot-configuration-classes, @Configuration>> |

spring-boot-docs/src/main/asciidoc/getting-started.adoc

+8-8
Original file line numberDiff line numberDiff line change
@@ -119,8 +119,8 @@ OSX Homebrew user try `brew install maven`. Ubuntu users can run
119119

120120
Spring Boot dependencies use the `org.springframework.boot` `groupId`. Typically your
121121
Maven POM file will inherit from the `spring-boot-starter-parent` project and declare
122-
dependencies to one or more <<using-spring-boot.adoc#using-boot-starter-poms, "`Starter
123-
POMs`">>. Spring Boot also provides an optional
122+
dependencies to one or more <<using-spring-boot.adoc#using-boot-starter,
123+
"`Starters`">>. Spring Boot also provides an optional
124124
<<build-tool-plugins.adoc#build-tool-plugins-maven-plugin, Maven plugin>> to create
125125
executable jars.
126126

@@ -205,7 +205,7 @@ installed you can follow the instructions at http://www.gradle.org/.
205205

206206
Spring Boot dependencies can be declared using the `org.springframework.boot` `group`.
207207
Typically your project will declare dependencies to one or more
208-
<<using-spring-boot.adoc#using-boot-starter-poms, "`Starter POMs`">>. Spring Boot
208+
<<using-spring-boot.adoc#using-boot-starter, "`Starters`">>. Spring Boot
209209
provides a useful <<build-tool-plugins.adoc#build-tool-plugins-gradle-plugin, Gradle plugin>>
210210
that can be used to simplify dependency declarations and to create executable jars.
211211

@@ -544,14 +544,14 @@ text editor for this example.
544544

545545
[[getting-started-first-application-dependencies]]
546546
=== Adding classpath dependencies
547-
Spring Boot provides a number of "`Starter POMs`" that make easy to add jars to your
547+
Spring Boot provides a number of "`Starters`" that make easy to add jars to your
548548
classpath. Our sample application has already used `spring-boot-starter-parent` in the
549549
`parent` section of the POM. The `spring-boot-starter-parent` is a special starter
550550
that provides useful Maven defaults. It also provides a
551551
<<using-spring-boot.adoc#using-boot-dependency-management,`dependency-management`>>
552552
section so that you can omit `version` tags for "`blessed`" dependencies.
553553

554-
Other "`Starter POMs`" simply provide dependencies that you are likely to need when
554+
Other "`Starters`" simply provide dependencies that you are likely to need when
555555
developing a specific type of application. Since we are developing a web application, we
556556
will add a `spring-boot-starter-web` dependency -- but before that, let's look at what we
557557
currently have.
@@ -643,11 +643,11 @@ dependencies that you have added. Since `spring-boot-starter-web` added Tomcat a
643643
Spring MVC, the auto-configuration will assume that you are developing a web application
644644
and setup Spring accordingly.
645645

646-
.Starter POMs and Auto-Configuration
646+
.Starters and Auto-Configuration
647647
****
648-
Auto-configuration is designed to work well with "`Starter POMs`", but the two concepts
648+
Auto-configuration is designed to work well with "`Starters`", but the two concepts
649649
are not directly tied. You are free to pick-and-choose jar dependencies outside of the
650-
starter POMs and Spring Boot will still do its best to auto-configure your application.
650+
starters and Spring Boot will still do its best to auto-configure your application.
651651
****
652652

653653

spring-boot-docs/src/main/asciidoc/howto.adoc

+6-6
Original file line numberDiff line numberDiff line change
@@ -885,7 +885,7 @@ classpath to reference Tomcat 7 .
885885
==== Use Tomcat 7 with Maven
886886
[[howto-use-tomcat-7-maven]]
887887

888-
If you are using the starter poms and parent you can just change the Tomcat version
888+
If you are using the starters and parent you can just change the Tomcat version
889889
property, e.g. for a simple webapp or service:
890890

891891
[source,xml,indent=0,subs="verbatim,quotes,attributes"]
@@ -932,7 +932,7 @@ dependencies.
932932
[[howto-use-jetty-8-maven]]
933933
==== Use Jetty 8 with Maven
934934

935-
If you are using the starter poms and parent you can just add the Jetty starter with
935+
If you are using the starters and parent you can just add the Jetty starter with
936936
the required WebSocket exclusion and change the version properties, e.g. for a simple
937937
webapp or service:
938938

@@ -1335,7 +1335,7 @@ have been applied from the auto-configuration:
13351335
Spring Boot has no mandatory logging dependency, except for the `commons-logging` API, of
13361336
which there are many implementations to choose from. To use http://logback.qos.ch[Logback]
13371337
you need to include it, and some bindings for `commons-logging` on the classpath. The
1338-
simplest way to do that is through the starter poms which all depend on
1338+
simplest way to do that is through the starters which all depend on
13391339
`spring-boot-starter-logging`. For a web application you only need
13401340
`spring-boot-starter-web` since it depends transitively on the logging starter.
13411341
For example, using Maven:
@@ -1438,12 +1438,12 @@ You also need to add `logging.file` to your `application.properties`:
14381438
[[howto-configure-log4j-for-logging]]
14391439
=== Configure Log4j for logging
14401440
Spring Boot supports http://logging.apache.org/log4j/2.x[Log4j 2] for logging
1441-
configuration if it is on the classpath. If you are using the starter poms for
1441+
configuration if it is on the classpath. If you are using the starters for
14421442
assembling dependencies that means you have to exclude Logback and then include log4j 2
1443-
instead. If you aren't using the starter poms then you need to provide `commons-logging`
1443+
instead. If you aren't using the starters then you need to provide `commons-logging`
14441444
(at least) in addition to Log4j 2.
14451445

1446-
The simplest path is probably through the starter poms, even though it requires some
1446+
The simplest path is probably through the starters, even though it requires some
14471447
jiggling with excludes, .e.g. in Maven:
14481448

14491449
[source,xml,indent=0,subs="verbatim,quotes,attributes"]

spring-boot-docs/src/main/asciidoc/production-ready-features.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ unless you enable Spring MVC as well.>>
1919
== Enabling production-ready features
2020
The {github-code}/spring-boot-actuator[`spring-boot-actuator`] module provides all of
2121
Spring Boot's production-ready features. The simplest way to enable the features is to add
22-
a dependency to the `spring-boot-starter-actuator` '`Starter POM`'.
22+
a dependency to the `spring-boot-starter-actuator` '`Starter`'.
2323

2424
.Definition of Actuator
2525
****
@@ -28,7 +28,7 @@ controlling something. Actuators can generate a large amount of motion from a sm
2828
change.
2929
****
3030

31-
To add the actuator to a Maven based project, add the following '`starter`'
31+
To add the actuator to a Maven based project, add the following '`Starter`'
3232
dependency:
3333

3434
[source,xml,indent=0]

spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc

+21-21
Original file line numberDiff line numberDiff line change
@@ -549,7 +549,7 @@ for specifying hierarchical configuration data. The `SpringApplication` class wi
549549
automatically support YAML as an alternative to properties whenever you have the
550550
http://www.snakeyaml.org/[SnakeYAML] library on your classpath.
551551

552-
NOTE: If you use '`starter POMs`' SnakeYAML will be automatically provided via
552+
NOTE: If you use '`Starters`' SnakeYAML will be automatically provided via
553553
`spring-boot-starter`.
554554

555555

@@ -1038,7 +1038,7 @@ http://logging.apache.org/log4j/2.x/[Log4J2] and http://logback.qos.ch/[Logback]
10381038
case loggers are pre-configured to use console output with optional file output also
10391039
available.
10401040

1041-
By default, If you use the '`Starter POMs`', Logback will be used for logging. Appropriate
1041+
By default, If you use the '`Starters`', Logback will be used for logging. Appropriate
10421042
Logback routing is also included to ensure that dependent libraries that use
10431043
Java Util Logging, Commons Logging, Log4J or SLF4J will all work correctly.
10441044

@@ -1961,7 +1961,7 @@ any of your JAX-RS resources are packaged as nested jars.
19611961
[[boot-features-embedded-container]]
19621962
=== Embedded servlet container support
19631963
Spring Boot includes support for embedded Tomcat, Jetty, and Undertow servers. Most
1964-
developers will simply use the appropriate '`Starter POM`' to obtain a fully configured
1964+
developers will simply use the appropriate '`Starter`' to obtain a fully configured
19651965
instance. By default the embedded server will listen for HTTP requests on port `8080`.
19661966

19671967

@@ -2500,7 +2500,7 @@ Here's the algorithm for choosing a specific implementation:
25002500
* Lastly, if Commons DBCP2 is available we will use it.
25012501

25022502
If you use the `spring-boot-starter-jdbc` or `spring-boot-starter-data-jpa`
2503-
'`starter POMs`' you will automatically get a dependency to `tomcat-jdbc`.
2503+
'`starters`' you will automatically get a dependency to `tomcat-jdbc`.
25042504

25052505
NOTE: You can bypass that algorithm completely and specify the connection pool to use via
25062506
the `spring.datasource.type` property. This is especially important if you are running
@@ -2922,7 +2922,7 @@ http://redis.io/[Redis] is a cache, message broker and richly-featured key-value
29222922
Spring Boot offers basic auto-configuration for the
29232923
https://github.com/xetorthio/jedis/[Jedis] client library and abstractions on top of it
29242924
provided by https://github.com/spring-projects/spring-data-redis[Spring Data Redis]. There
2925-
is a `spring-boot-starter-data-redis` '`Starter POM`' for collecting the dependencies in a
2925+
is a `spring-boot-starter-data-redis` '`Starter`' for collecting the dependencies in a
29262926
convenient way.
29272927

29282928

@@ -2962,7 +2962,7 @@ pooled connection factory by default.
29622962
http://www.mongodb.com/[MongoDB] is an open-source NoSQL document database that uses a
29632963
JSON-like schema instead of traditional table-based relational data. Spring Boot offers
29642964
several conveniences for working with MongoDB, including the
2965-
`spring-boot-starter-data-mongodb` '`Starter POM`'.
2965+
`spring-boot-starter-data-mongodb` '`Starter`'.
29662966

29672967

29682968

@@ -3118,7 +3118,7 @@ Mongo instance's configuration and logging routing.
31183118
http://neo4j.com/[Neo4j] is an open-source NoSQL graph database that uses a rich data
31193119
model of nodes related by first class relationships which is better suited for connected
31203120
big data than traditional rdbms approaches. Spring Boot offers several conveniences for
3121-
working with Neo4j, including the `spring-boot-starter-data-neo4j` '`Starter POM`'.
3121+
working with Neo4j, including the `spring-boot-starter-data-neo4j` '`Starter`'.
31223122

31233123

31243124

@@ -3238,7 +3238,7 @@ documentation].
32383238
https://github.com/spring-projects/spring-data-gemfire[Spring Data Gemfire] provides
32393239
convenient Spring-friendly tools for accessing the
32403240
http://pivotal.io/big-data/pivotal-gemfire#details[Pivotal Gemfire] data management
3241-
platform. There is a `spring-boot-starter-data-gemfire` '`Starter POM`' for collecting the
3241+
platform. There is a `spring-boot-starter-data-gemfire` '`Starter`' for collecting the
32423242
dependencies in a convenient way. There is currently no auto-configuration support for
32433243
Gemfire, but you can enable Spring Data Repositories with a
32443244
https://github.com/spring-projects/spring-data-gemfire/blob/master/src/main/java/org/springframework/data/gemfire/repository/config/EnableGemfireRepositories.java[single annotation (`@EnableGemfireRepositories`)].
@@ -3250,7 +3250,7 @@ https://github.com/spring-projects/spring-data-gemfire/blob/master/src/main/java
32503250
http://lucene.apache.org/solr/[Apache Solr] is a search engine. Spring Boot offers basic
32513251
auto-configuration for the Solr 5 client library and abstractions on top of it provided by
32523252
https://github.com/spring-projects/spring-data-solr[Spring Data Solr]. There is
3253-
a `spring-boot-starter-data-solr` '`Starter POM`' for collecting the dependencies in a
3253+
a `spring-boot-starter-data-solr` '`Starter`' for collecting the dependencies in a
32543254
convenient way.
32553255

32563256

@@ -3302,7 +3302,7 @@ http://www.elasticsearch.org/[Elasticsearch] is an open source, distributed,
33023302
real-time search and analytics engine. Spring Boot offers basic auto-configuration for
33033303
the Elasticsearch and abstractions on top of it provided by
33043304
https://github.com/spring-projects/spring-data-elasticsearch[Spring Data Elasticsearch].
3305-
There is a `spring-boot-starter-data-elasticsearch` '`Starter POM`' for collecting the
3305+
There is a `spring-boot-starter-data-elasticsearch` '`Starter`' for collecting the
33063306
dependencies in a convenient way.
33073307

33083308

@@ -3372,7 +3372,7 @@ http://cassandra.apache.org/[Cassandra] is an open source, distributed database
33723372
system designed to handle large amounts of data across many commodity servers. Spring Boot
33733373
offers auto-configuration for Cassandra and abstractions on top of it provided by
33743374
https://github.com/spring-projects/spring-data-cassandra[Spring Data Cassandra].
3375-
There is a `spring-boot-starter-data-cassandra` '`Starter POM`' for collecting the
3375+
There is a `spring-boot-starter-data-cassandra` '`Starter`' for collecting the
33763376
dependencies in a convenient way.
33773377

33783378

@@ -3428,7 +3428,7 @@ http://www.couchbase.com/[Couchbase] is an open-source, distributed multi-model
34283428
document-oriented database that is optimized for interactive applications. Spring Boot
34293429
offers auto-configuration for Couchbase and abstractions on top of it provided by
34303430
https://github.com/spring-projects/spring-data-couchbase[Spring Data Couchbase].
3431-
There is a `spring-boot-starter-data-couchbase` '`Starter POM`' for collecting the
3431+
There is a `spring-boot-starter-data-couchbase` '`Starter`' for collecting the
34323432
dependencies in a convenient way.
34333433

34343434

@@ -3554,7 +3554,7 @@ enabled via the `@EnableCaching` annotation.
35543554
NOTE: If you are using the cache infrastructure with beans that are not interface-based,
35553555
make sure to enable the `proxyTargetClass` attribute of `@EnableCaching`.
35563556

3557-
TIP: Use the `spring-boot-starter-cache` "`Starter POM`" to quickly add required caching
3557+
TIP: Use the `spring-boot-starter-cache` '`Starter`' to quickly add required caching
35583558
dependencies. If you are adding dependencies manually you should note that certain
35593559
implementations are only provided by the `spring-context-support` jar.
35603560

@@ -4047,7 +4047,7 @@ The Advanced Message Queuing Protocol (AMQP) is a platform-neutral, wire-level p
40474047
for message-oriented middleware. The Spring AMQP project applies core Spring concepts to
40484048
the development of AMQP-based messaging solutions. Spring Boot offers several
40494049
conveniences for working with AMQP via RabbitMQ, including the
4050-
`spring-boot-starter-amqp` '`Starter POM`'.
4050+
`spring-boot-starter-amqp` '`Starter`'.
40514051

40524052

40534053

@@ -4230,7 +4230,7 @@ disable the JTA auto-configuration.
42304230
[[boot-features-jta-atomikos]]
42314231
=== Using an Atomikos transaction manager
42324232
Atomikos is a popular open source transaction manager which can be embedded into your
4233-
Spring Boot application. You can use the `spring-boot-starter-jta-atomikos` Starter POM to
4233+
Spring Boot application. You can use the `spring-boot-starter-jta-atomikos` Starter to
42344234
pull in the appropriate Atomikos libraries. Spring Boot will auto-configure Atomikos and
42354235
ensure that appropriate `depends-on` settings are applied to your Spring beans for correct
42364236
startup and shutdown ordering.
@@ -4254,7 +4254,7 @@ property with a different value for each instance of your application.
42544254
[[boot-features-jta-bitronix]]
42554255
=== Using a Bitronix transaction manager
42564256
Bitronix is popular open source JTA transaction manager implementation. You can
4257-
use the `spring-boot-starter-jta-bitronix` starter POM to add the appropriate Bitronix
4257+
use the `spring-boot-starter-jta-bitronix` starter to add the appropriate Bitronix
42584258
dependencies to your project. As with Atomikos, Spring Boot will automatically configure
42594259
Bitronix and post-process your beans to ensure that startup and shutdown ordering is
42604260
correct.
@@ -4278,7 +4278,7 @@ property with a different value for each instance of your application.
42784278
[[boot-features-jta-narayana]]
42794279
=== Using a Narayana transaction manager
42804280
Narayana is popular open source JTA transaction manager implementation supported by JBoss.
4281-
You can use the `spring-boot-starter-jta-narayana` starter POM to add the appropriate
4281+
You can use the `spring-boot-starter-jta-narayana` starter to add the appropriate
42824282
Narayana dependencies to your project. As with Atomikos and Bitronix, Spring Boot will
42834283
automatically configure Narayana and post-process your beans to ensure that startup and
42844284
shutdown ordering is correct.
@@ -4399,7 +4399,7 @@ caching is enabled.
43994399
[[boot-features-integration]]
44004400
== Spring Integration
44014401
Spring Boot offers several conveniences for working with Spring Integration, including
4402-
the `spring-boot-starter-integration` '`Starter POM`'. Spring Integration provides
4402+
the `spring-boot-starter-integration` '`Starter`'. Spring Integration provides
44034403
abstractions over messaging and also other transports such as HTTP, TCP etc. If Spring
44044404
Integration is available on your classpath it will be initialized through the
44054405
`@EnableIntegration` annotation. Message processing statistics will be published over JMX
@@ -4458,7 +4458,7 @@ Spring Boot provides a number of utilities and annotations to help when testing
44584458
application. Test support is provided by two modules; `spring-boot-test` contains core
44594459
items, and `spring-boot-test-autoconfigure` supports auto-configuration for tests.
44604460

4461-
Most developers will just use the `spring-boot-starter-test` '`Starter POM`' which
4461+
Most developers will just use the `spring-boot-starter-test` '`Starter`' which
44624462
imports both Spring Boot test modules as well has JUnit, AssertJ, Hamcrest and a number
44634463
of other useful libraries.
44644464

@@ -4467,7 +4467,7 @@ of other useful libraries.
44674467
[[boot-features-test-scope-dependencies]]
44684468
=== Test scope dependencies
44694469
If you use the
4470-
`spring-boot-starter-test` '`Starter POM`' (in the `test` `scope`), you will find
4470+
`spring-boot-starter-test` '`Starter`' (in the `test` `scope`), you will find
44714471
the following provided libraries:
44724472

44734473
* http://junit.org[JUnit] -- The de-facto standard for unit testing Java applications.
@@ -4498,7 +4498,7 @@ needing to connect to other infrastructure.
44984498

44994499
The Spring Framework includes a dedicated test module for just such integration testing.
45004500
You can declare a dependency directly to `org.springframework:spring-test` or use the
4501-
`spring-boot-starter-test` '`Starter POM`' to pull it in transitively.
4501+
`spring-boot-starter-test` '`Starter`' to pull it in transitively.
45024502

45034503
If you have not used the `spring-test` module before you should start by reading the
45044504
{spring-reference}/#testing[relevant section] of the Spring Framework reference

0 commit comments

Comments
 (0)