Skip to content

Commit 964a3f0

Browse files
author
Joshua Hoblitt
committed
fix minor typos and line wrapping in README
1 parent 6fe72c8 commit 964a3f0

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

README.md

+14-12
Original file line numberDiff line numberDiff line change
@@ -54,11 +54,12 @@ completely as raw strings but this module. No effort is made to handle
5454
`boolean` or `integer` values as `pure-ftpd` itself is not consistent in how it
5555
handles these values.
5656

57-
For example, if you wanted to create the configuration option example below in the file `/etc/pure-ftpd/pure-ftpd.conf`,
57+
For example, if you wanted to create the configuration option example below in
58+
the file `/etc/pure-ftpd/pure-ftpd.conf`:
5859

5960
ChrootEveryone yes
6061

61-
You would declare it like this to the puppet module:
62+
You would declare it like this to the `pureftpd` module:
6263

6364
class { 'pureftpd':
6465
config => {
@@ -87,7 +88,8 @@ There is a list of command line switches in the distribution's
8788
[`README`](https://github.com/jedisct1/pure-ftpd/blob/master/README) that
8889
should all have `pure-ftpd.conf` option analogs.
8990

90-
Here are some useful sources for discovering configuration parameters with examples:
91+
Here are some useful sources for discovering configuration parameters with
92+
examples:
9193

9294
* [`pure-ftpd.conf`](https://github.com/jedisct1/pure-ftpd/blob/master/configuration-file/pure-ftpd.conf.in)
9395
* [`pureftpd-ldap.conf`](https://github.com/jedisct1/pure-ftpd/blob/master/pureftpd-ldap.conf)
@@ -109,8 +111,8 @@ Install the `pure-ftpd` package with an empty `pure-ftpd.conf` config file
109111

110112
### Setting Configuration Options
111113

112-
Options for `pure-ftpd.conf`] should be passed into the `config` class
113-
parameter as a hash.
114+
Options for `pure-ftpd.conf` should be passed into the `config` class parameter
115+
as a hash.
114116

115117
class { 'pureftpd':
116118
config => {
@@ -181,7 +183,7 @@ parameter as a hash.
181183

182184
### Enabling LDAP Authentication
183185

184-
Options for `pureftpd-ldap.conf`] should be passed into the `config_ldap` class
186+
Options for `pureftpd-ldap.conf` should be passed into the `config_ldap` class
185187
parameter as a hash.
186188

187189
class { 'pureftpd':
@@ -204,7 +206,7 @@ parameter as a hash.
204206

205207
### Enabling MYSQL Authentication
206208

207-
Options for `pureftpd-mysql.conf`] should be passed into the `config_mysql`
209+
Options for `pureftpd-mysql.conf` should be passed into the `config_mysql`
208210
class parameter as a hash.
209211

210212
class { 'pureftpd':
@@ -235,7 +237,7 @@ class parameter as a hash.
235237

236238
### Enabling PGSQL Authentication
237239

238-
Options for `pureftpd-pgsql.conf`] should be passed into the `config_pgsql`
240+
Options for `pureftpd-pgsql.conf` should be passed into the `config_pgsql`
239241
class parameter as a hash.
240242

241243
class { 'pureftpd':
@@ -401,10 +403,10 @@ support for other platform should be trivial but needs to involve full up
401403
integration testing.
402404

403405
The supported configuration file values were discovered via code inspection of
404-
the `pure-ftpd` `v1.0.31` release. There are possibly new configuration
405-
values that have been introduced it subsequent releases. Any configuration
406-
values present in a `pure-ftpd` but not supported by this module should be
407-
considered a bug.
406+
the `pure-ftpd` `v1.0.31` release. There are possibly new configuration values
407+
that have been introduced in subsequent releases. Any configuration values
408+
present in a stable `pure-ftpd` release but not supported by this module should
409+
be considered a bug.
408410

409411
### Tested Platforms
410412

0 commit comments

Comments
 (0)