Skip to content

Commit

Permalink
Merge pull request #645 from jbampton/fix-grammar-and-spelling
Browse files Browse the repository at this point in the history
docs: fix grammar and spelling [ci-skip]
  • Loading branch information
rafaelfranca authored Nov 23, 2021
2 parents 6bba044 + 619d552 commit 9c69472
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 15 deletions.
8 changes: 4 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,7 @@
`APP_ROOT/tmp/spring`, which caused problems on filesystems which did
not support sockets, and also caused problems if `APP_ROOT` was
sufficiently deep in the filesystem to exhaust the operating system's
socket name limit. Hence we had a `SPRING_TMP_PATH` environment
socket name limit. Hence, we had a `SPRING_TMP_PATH` environment
variable for configuration. We now use `/tmp/spring/[md5(APP_ROOT)]`
for the socket and `/tmp/spring/[md5(APP_ROOT)].pid` for the pid file.
Thanks @Kriechi for the suggestion. Setting `SPRING_TMP_PATH` no longer
Expand Down Expand Up @@ -295,7 +295,7 @@
`SPRING_LOG` environment variable.
* Fix hang on "Run `bundle install` to install missing gems"
* Added hack to make backtraces generated when running a command
quieter (by stripping out all of the lines relating to spring)
quieter (by stripping out all the lines relating to spring)
* Rails 4 is officially supported

## 0.0.10
Expand All @@ -309,7 +309,7 @@
an error either.
* Don't preload `test_helper` or `spec_helper` by default. This was
causing people subtle problems (for example see #113) and is perhaps
surprising behaviour. It may be desirable but it depends on the
surprising behaviour. It may be desirable, but it depends on the
application, therefore we suggest it to people in the README but no
longer do it by default.
* Don't stay connected to database in the application processes. There's
Expand Down Expand Up @@ -342,7 +342,7 @@
[console|runner|generate]`.
* `config/spring.rb` is only loaded in the server process, so you can
require stuff from other gems there without performance implications.
* File watcher no longer pays attention to files outside of your
* File watcher no longer pays attention to files outside your
application root directory.
* You can use the `listen` gem for less CPU intensive file watching. See
README.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Rails app in `test/apps/`. On each test run, the dummy app is copied to
`test/apps/tmp/` so that any changes won't affect the pre-generated app
(this saves us having to regenerate the app on each run).

If tests are failing and you don't know why, it might be that the
If tests are failing, and you don't know why, it might be that the
pre-generated app has become inconsistent in some way. In that case the
best solution is to purge it with `rm -rf test/apps/*` and then run the
acceptance tests again, which will generate a new app.
Expand All @@ -33,7 +33,7 @@ You can set the `RAILS_VERSION` environment variable:
$ RAILS_VERSION="~> 3.2.0" rake test:acceptance
```

The apps in `test/apps` will be named based on the rails version and the
The apps in `test/apps` will be named based on the rails version, and the
Spring version.

## Testing with your app
Expand Down
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
[![Gem Version](https://badge.fury.io/rb/spring.svg)](http://badge.fury.io/rb/spring)

Spring is a Rails application preloader. It speeds up development by
keeping your application running in the background so you don't need to
keeping your application running in the background, so you don't need to
boot it every time you run a test, rake task or migration.

## Features
Expand Down Expand Up @@ -57,7 +57,7 @@ end

On platforms where Spring is installed and supported, this snippet
hooks Spring into the execution of commands. In other cases, the snippet
will just be silently ignored and the lines after it will be executed as
will just be silently ignored, and the lines after it will be executed as
normal.

If you don't want to prefix every command you type with `bin/`, you
Expand Down Expand Up @@ -179,7 +179,7 @@ Spring is running:
```

There's no need to "shut down" Spring. This will happen automatically
when you close your terminal. However if you do want to do a manual shut
when you close your terminal. However, if you do want to do a manual shut
down, use the `stop` command:

```
Expand Down Expand Up @@ -371,7 +371,7 @@ application restart, you can specify them with `Spring.watch`:
Spring.watch "config/some_config_file.yml"
```

By default Spring polls the filesystem for changes once every 0.2 seconds. This
By default, Spring polls the filesystem for changes once every 0.2 seconds. This
method requires zero configuration, but if you find that it's using too
much CPU, then you can use event-based file system listening by
installing the
Expand All @@ -391,24 +391,24 @@ Spring.quiet = true

The following environment variables are used by Spring:

* `DISABLE_SPRING` - If set, Spring will be bypassed and your
* `DISABLE_SPRING` - If set, Spring will be bypassed, and your
application will boot in a foreground process
* `SPRING_LOG` - The path to a file which Spring will write log messages
to.
* `SPRING_TMP_PATH` - The directory where Spring should write its temporary
files (a pidfile and a socket). By default we use the
files (a pidfile and a socket). By default, we use the
`XDG_RUNTIME_DIR` environment variable, or else `Dir.tmpdir`, and then
create a directory in that named `spring-$UID`. We don't use your
Rails application's `tmp/` directory because that may be on a
filesystem which doesn't support UNIX sockets.
* `SPRING_APPLICATION_ID` - Used to identify distinct Rails
applications. By default it is an MD5 hash of the current
applications. By default, it is an MD5 hash of the current
`RUBY_VERSION`, and the path to your Rails project root.
* `SPRING_SOCKET` - The path which should be used for the UNIX socket
which Spring uses to communicate with the long-running Spring server
process. By default this is `SPRING_TMP_PATH/SPRING_APPLICATION_ID`.
process. By default, this is `SPRING_TMP_PATH/SPRING_APPLICATION_ID`.
* `SPRING_PIDFILE` - The path which should be used to store the pid of
the long-running Spring server process. By default this is related to
the long-running Spring server process. By default, this is related to
the socket path; if the socket path is `/foo/bar/spring.sock` the
pidfile will be `/foo/bar/spring.pid`.
* `SPRING_SERVER_COMMAND` - The command to run to start up the Spring
Expand Down

0 comments on commit 9c69472

Please sign in to comment.