Skip to content

Commit f8bebb9

Browse files
author
Joshua Hoblitt
committed
update README boilerplate sections, formatting, and ToC
1 parent e077a61 commit f8bebb9

File tree

1 file changed

+44
-25
lines changed

1 file changed

+44
-25
lines changed

README.md

Lines changed: 44 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
Puppet udev Module
2-
=========================
2+
==================
33

44
[![Build Status](https://travis-ci.org/jhoblitt/puppet-udev.png)](https://travis-ci.org/jhoblitt/puppet-udev)
55

@@ -8,9 +8,15 @@ Puppet udev Module
88
1. [Overview](#overview)
99
2. [Description](#description)
1010
3. [Usage](#usage)
11+
* [Simple](#simple)
12+
* [Managing `udev` syslog verbosity] (#managing-udev-syslog-verbosity)
13+
* [Managing `udev` rules](#managing-udev-rules)
14+
* [Manually triggering a `udev` device rules reload](#manually-triggering-a-udev-device-rules-reload)
1115
4. [Limitations](#limitations)
1216
* [Tested Platforms](#tested-platforms)
13-
5. [Support](#support)
17+
5. [Versioning](#versioning)
18+
6. [Support](#support)
19+
7. [See Also](#see-also)
1420

1521

1622
Overview
@@ -25,16 +31,17 @@ Description
2531
This module installs and manages the
2632
[`udev`](http://www.freedesktop.org/software/systemd/man/udev.html) package.
2733

34+
2835
Usage
2936
-----
3037

31-
### Basic Example
38+
### Simple
3239

3340
This class does not need to be manually included in the manifest when using the
3441
`udev::rule` defined type.
3542

3643
```puppet
37-
include udev
44+
include udev
3845
```
3946

4047
### Managing `udev` syslog verbosity
@@ -43,7 +50,7 @@ Controls the value of `udev_log` in `udev.conf` and change the runtime syslog
4350
verbosity of the daemon.
4451

4552
```puppet
46-
class { 'udev': udev_log => 'debug' }
53+
class { 'udev': udev_log => 'debug' }
4754
```
4855

4956
### Managing `udev` rules
@@ -53,42 +60,41 @@ Note that either the `content` or `source` parameter must be specified unless
5360
not specify both.
5461

5562
```puppet
56-
udev::rule { '60-raw.rules':
57-
ensure => present,
58-
content => 'ACTION=="add", KERNEL=="sda", RUN+="/bin/raw /dev/raw/raw1 %N"',
59-
}
63+
udev::rule { '60-raw.rules':
64+
ensure => present,
65+
content => 'ACTION=="add", KERNEL=="sda", RUN+="/bin/raw /dev/raw/raw1 %N"',
66+
}
6067
```
6168

6269
As is commonly done with the `file` type, you can pass the output of the `template()` function to `content`.
6370

6471
```puppet
65-
udev::rule { '99-foo.rules':
66-
ensure => present,
67-
content => template('mymodule/foo.rules.erb'),
68-
}
72+
udev::rule { '99-foo.rules':
73+
ensure => present,
74+
content => template('mymodule/foo.rules.erb'),
75+
}
6976
```
7077

7178
```puppet
72-
udev::rule { '99-foo.rules':
73-
ensure => present,
74-
source => "puppet:///modules/${module_name}/foo.rules",
75-
}
79+
udev::rule { '99-foo.rules':
80+
ensure => present,
81+
source => "puppet:///modules/${module_name}/foo.rules",
82+
}
7683
```
7784

7885
```puppet
79-
udev::rule { '99-foo.rules':
80-
ensure => absent,
81-
}
86+
udev::rule { '99-foo.rules':
87+
ensure => absent,
88+
}
8289
```
8390

84-
8591
### Manually triggering a `udev` device rules reload
8692

8793
```puppet
88-
file { '/etc/etc/udev/rules.d/99-myfrobnicator.rules':
89-
...
90-
notify => Class['udev::udevadm::trigger'],
91-
}
94+
file { '/etc/etc/udev/rules.d/99-myfrobnicator.rules':
95+
...
96+
notify => Class['udev::udevadm::trigger'],
97+
}
9298
```
9399

94100

@@ -107,9 +113,22 @@ file (one without any fragments).
107113
* el6.x
108114

109115

116+
Versioning
117+
----------
118+
119+
This module is versioned according to the [Semantic Versioning
120+
2.0.0](http://semver.org/spec/v2.0.0.html) specification.
121+
122+
110123
Support
111124
-------
112125

113126
Please log tickets and issues at
114127
[github](https://github.com/jhoblitt/puppet-udev/issues)
115128

129+
130+
See Also
131+
--------
132+
133+
* [`udev` manpage](http://www.freedesktop.org/software/systemd/man/udev.html)
134+

0 commit comments

Comments
 (0)