Skip to content

Commit 63dc849

Browse files
authored
Minor text edits in the docs files (#155)
1 parent 6f9bd7a commit 63dc849

File tree

3 files changed

+14
-13
lines changed

3 files changed

+14
-13
lines changed

docs/CONFIGURATION.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Each worker process will serve exactly one client at a time.
1616

1717
### `listen`
1818

19-
By default pitchfork listen to port 8080.
19+
By default Pitchfork listens to port 8080.
2020

2121
```ruby
2222
listen 2007
@@ -25,19 +25,20 @@ listen 8080, tcp_nopush: true
2525
```
2626

2727
Adds an address to the existing listener set. May be specified more
28-
than once. address may be an Integer port number for a TCP port, an
28+
than once. The address may be an Integer port number for a TCP port, an
2929
`IP_ADDRESS:PORT` for TCP listeners or a pathname for UNIX domain sockets.
3030

3131
```ruby
3232
listen 3000 # listen to port 3000 on all TCP interfaces
33-
listen "127.0.0.1:3000" # listen to port 3000 on the loopback interface
33+
listen "127.0.0.1:3000" # listen to port 3000 on the loopback interface
3434
listen "/path/to/.pitchfork.sock" # listen on the given Unix domain socket
3535
listen "[::1]:3000" # listen to port 3000 on the IPv6 loopback interface
3636
```
3737

3838
When using Unix domain sockets, be sure:
3939
1) the path matches the one used by nginx
40-
2) uses the same filesystem namespace as the nginx process
40+
2) to use the same filesystem namespace as the nginx process
41+
4142
For systemd users using PrivateTmp=true (for either nginx or pitchfork),
4243
this means Unix domain sockets must not be placed in /tmp
4344

@@ -152,7 +153,7 @@ The following options may be specified (but are generally not needed):
152153
disproportionally more requests than workers with higher PID.
153154
It generally isn't a problem, especially when reforking is enabled, but for
154155
applications that are routinely over provisioned, it may be desirable to
155-
ensure all workers at least get some incoming requests so the can warm up.
156+
ensure all workers at least get some incoming requests so they can warm up.
156157

157158
Creating more than one queue allow to restrict which worker can process
158159
a given incomming request, hence making the load balancing fairer.
@@ -263,7 +264,7 @@ Due the low-complexity, low-overhead implementation, timeouts of less
263264
than 3.0 seconds can be considered inaccurate and unsafe.
264265

265266
For running Pitchfork behind nginx, it is recommended to set
266-
"fail_timeout=0" for in your nginx configuration like this
267+
"fail_timeout=0" in your nginx configuration like this
267268
to have nginx always retry backends that may have had workers
268269
exit or be SIGKILL-ed due to timeouts.
269270

@@ -307,14 +308,14 @@ The default Logger will log its output to STDERR.
307308

308309
## Callbacks
309310

310-
Because pitchfork several callbacks around the lifecycle of workers.
311+
Pitchfork provides several callbacks hooks around the lifecycle of workers.
311312
It is often necessary to use these callbacks to close inherited connection after fork.
312313

313-
Note that when reforking is available, the `pitchfork` monitor process won't load your application
314+
Note that when reforking is available, the Pitchfork monitor process won't load your application
314315
at all. As such for hooks executed in the monitor, you may need to explicitly load the parts of your
315316
application that are used in hooks.
316317

317-
`pitchfork` also don't attempt to rescue hook errors. Raising from a worker hook will crash the worker,
318+
Pitchfork also doesn't attempt to rescue hook errors. Raising from a worker hook will crash the worker,
318319
and raising from a monitor hook will bring the whole cluster down.
319320

320321
### `after_monitor_ready`
@@ -330,7 +331,7 @@ end
330331

331332
### `before_fork`
332333

333-
Called by the mold before forking a new workers, and by workers before they spawn a new mold.
334+
Called by the mold before forking new workers, and by workers before they spawn a new mold.
334335

335336
```ruby
336337
before_fork do |server|

docs/DESIGN.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
* Simplicity: Pitchfork is a traditional UNIX prefork web server.
44
No threads are used at all, this makes applications easier to debug
55
and fix.
6-
7-
* Resiliency: If something in goes catastrophically wrong and your application
6+
7+
* Resiliency: If something goes catastrophically wrong and your application
88
is dead locked or somehow stuck, once the request timeout is reached the master
99
process will take care of sending `kill -9` to the affected worker and
1010
spawn a new one to replace it.

docs/TUNING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ See Pitchfork::Configurator for details on the config file format.
2929

3030
* Bigger is better. The more `worker_processes` you run, the more you'll
3131
benefit from Copy-on-Write. If your application use 1GiB of memory after boot,
32-
running `10` worker process, the relative memory usage per worker will only be
32+
running `10` worker processes, the relative memory usage per worker will only be
3333
`~100MiB`, whereas if you only run `5` worker processes, there relative usage will be
3434
`~200MiB`.
3535
So if you can chose your hardware, it's preferable to use a smaller number

0 commit comments

Comments
 (0)