From bbf3076d9d5583b93eb2b61978dd3f8e4027a8a4 Mon Sep 17 00:00:00 2001 From: Eric Dahl Date: Thu, 2 Oct 2014 20:45:05 -0700 Subject: [PATCH] Fix some grammar issues in docs --- CONTRIBUTING.adoc | 2 +- .../src/main/asciidoc/getting-started.adoc | 8 ++++---- spring-boot-docs/src/main/asciidoc/howto.adoc | 4 ++-- .../main/asciidoc/spring-boot-features.adoc | 20 +++++++++---------- 4 files changed, 17 insertions(+), 17 deletions(-) diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc index 3e6073cb09..3b1c4b766a 100644 --- a/CONTRIBUTING.adoc +++ b/CONTRIBUTING.adoc @@ -145,7 +145,7 @@ The generated eclipse projects can be imported by selecting `import existing pro from the `file` menu. === Importing into other IDEs -Maven is well supported by most Java IDEs. Refer to you vendor documentation. +Maven is well supported by most Java IDEs. Refer to your vendor documentation. == Integration tests The sample application are used as integration tests during the build (when you diff --git a/spring-boot-docs/src/main/asciidoc/getting-started.adoc b/spring-boot-docs/src/main/asciidoc/getting-started.adoc index 08e8f7fbb4..cb8ecdf41c 100644 --- a/spring-boot-docs/src/main/asciidoc/getting-started.adoc +++ b/spring-boot-docs/src/main/asciidoc/getting-started.adoc @@ -337,7 +337,7 @@ are automatically registered with your shell. [[getting-started-cli-example]] ==== Quick start Spring CLI example -Here's a really simple web application that you can use to test you installation. Create +Here's a really simple web application that you can use to test your installation. Create a file called `app.groovy`: [source,groovy,indent=0,subs="verbatim,quotes,attributes"] @@ -361,7 +361,7 @@ Then simply run it from a shell: ---- NOTE: It will take some time when you first run the application as dependencies are -downloaded, subsequent runs will be much quicker. +downloaded. Subsequent runs will be much quicker. Open http://localhost:8080 in your favorite web browser and you should see the following output: @@ -422,7 +422,7 @@ that you have created a suitable folder and that it is your ``current directory' [[getting-started-first-application-pom]] === Creating the POM We need to start by creating a Maven `pom.xml` file. The `pom.xml` is the recipe that -will be used to build your project. Open you favorite text editor and add the following: +will be used to build your project. Open your favorite text editor and add the following: [source,xml,indent=0,subs="verbatim,quotes,attributes"] ---- @@ -500,7 +500,7 @@ currently have. [INFO] com.example:myproject:jar:0.0.1-SNAPSHOT ---- -The `mvn dependency:tree` command prints tree representation of your project dependencies. +The `mvn dependency:tree` command prints a tree representation of your project dependencies. You can see that `spring-boot-starter-parent` provides no dependencies by itself. Let's edit our `pom.xml` and add the `spring-boot-starter-web` dependency just below the `parent` section: diff --git a/spring-boot-docs/src/main/asciidoc/howto.adoc b/spring-boot-docs/src/main/asciidoc/howto.adoc index a01483787c..890008f311 100644 --- a/spring-boot-docs/src/main/asciidoc/howto.adoc +++ b/spring-boot-docs/src/main/asciidoc/howto.adoc @@ -762,8 +762,8 @@ The multipart support is helpful when you want to receive multipart encoded file a `@RequestParam`-annotated parameter of type `MultipartFile` in a Spring MVC controller handler method. -See the {sc-spring-boot-autoconfigure}/web/MultipartAutoConfiguration.{sc-ext}[`MultipartAutoConfiguration`] s -ource for more details. +See the {sc-spring-boot-autoconfigure}/web/MultipartAutoConfiguration.{sc-ext}[`MultipartAutoConfiguration`] +source for more details. diff --git a/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc b/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc index 87a24073f1..a6de6df80a 100644 --- a/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc +++ b/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc @@ -308,8 +308,8 @@ can set up default values for your application in `application.properties` (or w other basename you choose with `spring.config.name`) and override it at runtime with a different file, keeping the defaults. -NOTE: if you use environment variables not system properties, most operating systems -disallow period-separated key names, but you can use underscores instead (e.g. +NOTE: If you use environment variables rather than system properties, most operating +systems disallow period-separated key names, but you can use underscores instead (e.g. `SPRING_CONFIG_NAME` instead of `spring.config.name`). NOTE: If you are running in a container then JNDI properties (in `java:comp/env`) or @@ -324,7 +324,7 @@ In addition to `application.properties` files, profile specific properties can a defined using the naming convention `application-{profile}.properties`. Profile specific properties are loaded from the same locations as standard -`application.properties`, with profiles specific files overriding the default ones. +`application.properties`, with profile specific files overriding the default ones. @@ -369,7 +369,7 @@ For example, the following YAML document: [source,yaml,indent=0] ---- environments: - dev:` + dev: url: http://dev.bar.com name: Developer Setup prod: @@ -436,7 +436,7 @@ placeholders syntax to access YAML properties. [[boot-features-external-config-multi-profile-yaml]] ==== Multi-profile YAML documents You can specify multiple profile-specific YAML documents in a single file by -by using a `spring.profiles` key to indicate when the document applies. For example: +using a `spring.profiles` key to indicate when the document applies. For example: [source,yaml,indent=0] ---- @@ -675,12 +675,12 @@ http://logging.apache.org/log4j/[Log4J] and http://logback.qos.ch/[Logback]. In each case there is console output and file output (rotating, 10 Mb file size). -By default, If you use the ``Starter POMs'', Logback will be used for logging. Appropriate +By default, if you use the ``Starter POMs'', Logback will be used for logging. Appropriate Logback routing is also included to ensure that dependent libraries that use Java Util Logging, Commons Logging, Log4J or SLF4J will all work correctly. TIP: There are a lot of logging frameworks available for Java. Don't worry if the above -list seems confusing, generally you won't need to change your logging dependencies and +list seems confusing. Generally you won't need to change your logging dependencies and the Spring Boot defaults will work just fine. @@ -700,7 +700,7 @@ The default log output from Spring Boot looks like this: The following items are output: -* Date and Time -- Millesecond precision and easily sortable. +* Date and Time -- Millisecond precision and easily sortable. * Log Level -- `ERROR`, `WARN`, `INFO`, `DEBUG` or `TRACE`. * Process ID. * A `---` separator to distinguish the start of actual log messages. @@ -801,7 +801,7 @@ To help with the customization some other properties are transferred from the Sp All the logging systems supported can consult System properties when parsing their configuration files. See the default configurations in `spring-boot.jar` for examples. -WARNING: There are know classloading issues with Java Util Logging that cause problems +WARNING: There are known classloading issues with Java Util Logging that cause problems when running from an ``executable jar''. We recommend that you avoid it if at all possible. @@ -1335,7 +1335,7 @@ Production database connections can also be auto-configured using a pooling * Lastly, if Commons DBCP2 is available we will use it If you use the `spring-boot-starter-jdbc` or `spring-boot-starter-data-jpa` -``starter POMs'' you will automcatically get a dependency to `tomcat-jdbc`. +``starter POMs'' you will automatically get a dependency to `tomcat-jdbc`. NOTE: Additional connection pools can always be configured manually. If you define your own `DataSource` bean, auto-configuration will not occur.