Skip to content

Commit 725d469

Browse files
committed
(MODULES-8183) REFERENCE.md ToC fixes
1 parent dceffe1 commit 725d469

File tree

2 files changed

+27
-18
lines changed

2 files changed

+27
-18
lines changed

REFERENCE.md

Lines changed: 23 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,44 @@
11
# Reference
2+
23
<!-- DO NOT EDIT: This document was generated by Puppet Strings -->
34

45
## Table of Contents
56

6-
**Resource types**
7+
### Resource types
78

8-
* [`host`](#host): Installs and manages host entries. For most systems, these entries will just be in `/etc/hosts`, but some systems (notably OS X) will have d
9+
* [`host`](#host): Installs and manages host entries.
910

1011
## Resource types
1112

12-
### host
13+
### <a name="host"></a>`host`
1314

14-
Installs and manages host entries. For most systems, these
15-
entries will just be in `/etc/hosts`, but some systems (notably OS X)
16-
will have different solutions.
15+
For most systems, these entries will just be in `/etc/hosts`, but some
16+
systems (notably OS X) will have different solutions.
1717

1818
#### Properties
1919

2020
The following properties are available in the `host` type.
2121

22-
##### `ensure`
22+
##### `comment`
2323

24-
Valid values: present, absent
24+
A comment that will be attached to the line with a # character.
2525

26-
The basic property that the resource should be in.
26+
##### `ensure`
2727

28-
Default value: present
28+
Valid values: `present`, `absent`
2929

30-
##### `ip`
30+
The basic property that the resource should be in.
3131

32-
The host's IP address, IPv4 or IPv6.
32+
Default value: `present`
3333

3434
##### `host_aliases`
3535

3636
Any aliases the host might have. Multiple values must be
3737
specified as an array.
3838

39-
##### `comment`
39+
##### `ip`
4040

41-
A comment that will be attached to the line with a # character.
41+
The host's IP address, IPv4 or IPv6.
4242

4343
##### `target`
4444

@@ -49,9 +49,17 @@ those providers that write to disk. On most systems this defaults to `/etc/hosts
4949

5050
The following parameters are available in the `host` type.
5151

52-
##### `name`
52+
* [`name`](#name)
53+
* [`provider`](#provider)
54+
55+
##### <a name="name"></a>`name`
5356

5457
namevar
5558

5659
The host name.
5760

61+
##### <a name="provider"></a>`provider`
62+
63+
The specific backend to use for this `host` resource. You will seldom need to specify this --- Puppet will usually
64+
discover the appropriate provider for your platform.
65+

lib/puppet/type/host.rb

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
require 'puppet/property/ordered_list'
22

33
Puppet::Type.newtype(:host) do
4-
@doc = "Installs and manages host entries. For most systems, these
5-
entries will just be in `/etc/hosts`, but some systems (notably OS X)
6-
will have different solutions."
4+
@doc = "@summary Installs and manages host entries.
5+
6+
For most systems, these entries will just be in `/etc/hosts`, but some
7+
systems (notably OS X) will have different solutions."
78

89
ensurable
910

0 commit comments

Comments
 (0)