Skip to content

Commit 3934a55

Browse files
authored
Correct puppet-strings documentation (#192)
In various places @attr was used instead of @param. It also didn't use the @summary tag which led to odd summaries. Then some indenting was incorrect. It also uses a newer version of puppet-strings which generates a list of parameters with links.
1 parent f419e4b commit 3934a55

11 files changed

+482
-211
lines changed

Diff for: REFERENCE.md

+453-175
Large diffs are not rendered by default.

Diff for: manifests/dropin_file.pp

+10-10
Original file line numberDiff line numberDiff line change
@@ -4,40 +4,40 @@
44
#
55
# @see systemd.unit(5)
66
#
7-
# @attr name [Pattern['^[^/]+\.conf$']]
7+
# @param name [Pattern['^[^/]+\.conf$']]
88
# The target unit file to create
99
#
10-
# @attr path
10+
# @param path
1111
# The main systemd configuration path
1212
#
13-
# @attr selinux_ignore_defaults
13+
# @param selinux_ignore_defaults
1414
# If Puppet should ignore the default SELinux labels.
1515
#
16-
# @attr content
16+
# @param content
1717
# The full content of the unit file
1818
#
1919
# * Mutually exclusive with ``$source``
2020
#
21-
# @attr source
21+
# @param source
2222
# The ``File`` resource compatible ``source``
2323
#
2424
# * Mutually exclusive with ``$content``
2525
#
26-
# @attr target
26+
# @param target
2727
# If set, will force the file to be a symlink to the given target
2828
#
2929
# * Mutually exclusive with both ``$source`` and ``$content``
3030
#
31-
# @attr owner
31+
# @param owner
3232
# The owner to set on the dropin file
3333
#
34-
# @attr group
34+
# @param group
3535
# The group to set on the dropin file
3636
#
37-
# @attr mode
37+
# @param mode
3838
# The mode to set on the dropin file
3939
#
40-
# @attr show_diff
40+
# @param show_diff
4141
# Whether to show the diff when updating dropin file
4242
#
4343
define systemd::dropin_file (

Diff for: manifests/journald.pp

+2-4
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
# @api private
2-
#
3-
# This class manages and configures journald.
4-
#
5-
# https://www.freedesktop.org/software/systemd/man/journald.conf.html
2+
# @summary This class manages and configures journald.
3+
# @see https://www.freedesktop.org/software/systemd/man/journald.conf.html
64
class systemd::journald {
75
assert_private()
86

Diff for: manifests/logind.pp

+2-4
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
# @api private
2-
#
3-
# This class manages systemd's login manager configuration.
4-
#
5-
# https://www.freedesktop.org/software/systemd/man/logind.conf.html
2+
# @summary This class manages systemd's login manager configuration.
3+
# @see https://www.freedesktop.org/software/systemd/man/logind.conf.html
64
class systemd::logind {
75
assert_private()
86

Diff for: manifests/network.pp

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
# -- Define: systemd::network
2-
# Creates network config for systemd-networkd
1+
# @summary Creates network config for systemd-networkd
32
define systemd::network (
43
Enum['file', 'absent'] $ensure = file,
54
Stdlib::Absolutepath $path = '/etc/systemd/network',

Diff for: manifests/resolved.pp

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# @api private
22
#
3-
# This class provides an abstract way to trigger resolved.
4-
# Each parameters correspond to resolved.conf(5):
5-
# https://www.freedesktop.org/software/systemd/man/resolved.conf.html
3+
# @summary This class provides an abstract way to trigger resolved.
4+
# Each parameters correspond to resolved.conf(5)
5+
# @see https://www.freedesktop.org/software/systemd/man/resolved.conf.html
66
#
77
# @param ensure
88
# The state that the ``resolved`` service should be in

Diff for: manifests/service_limits.pp

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@
44
#
55
# @see systemd.exec(5)
66
#
7-
# @attr name [Pattern['^.+\.(service|socket|mount|swap)$']]
7+
# @param name [Pattern['^.+\.(service|socket|mount|swap)$']]
88
# The name of the service that you will be modifying
99
#
10-
# @param $ensure
10+
# @param ensure
1111
# Whether to drop a file or remove it
1212
#
1313
# @param path
@@ -24,7 +24,7 @@
2424
# @param source
2525
# A ``File`` resource compatible ``source``
2626
#
27-
# * Mutually exclusive with ``$limits``
27+
# * Mutually exclusive with ``$limits``
2828
#
2929
# @param restart_service
3030
# Restart the managed service after setting the limits

Diff for: manifests/timesyncd.pp

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
# @param ensure
66
# The state that the ``networkd`` service should be in
77
#
8-
# @param $ntp_server
8+
# @param ntp_server
99
# A space-separated list of NTP servers, will be combined with interface specific
1010
# addresses from systemd-networkd. requires puppetlabs-inifile
1111
#

Diff for: manifests/tmpfile.pp

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@
44
#
55
# @see systemd-tmpfiles(8)
66
#
7-
# @attr name [Pattern['^[^/]+\.conf$']] (filename)
7+
# @param name [Pattern['^[^/]+\.conf$']] (filename)
88
# The name of the tmpfile to create
99
#
10-
# @param $ensure
10+
# @param ensure
1111
# Whether to drop a file or remove it
1212
#
1313
# @param path
@@ -21,7 +21,7 @@
2121
# @param source
2222
# A ``File`` resource compatible ``source``
2323
#
24-
# * Mutually exclusive with ``$limits``
24+
# * Mutually exclusive with ``$limits``
2525
#
2626
define systemd::tmpfile (
2727
Enum['present', 'absent', 'file'] $ensure = 'file',

Diff for: manifests/udev/rule.pp

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@
44
#
55
# @see udev(7)
66
#
7-
# @attr name [Pattern['^.+\.rules$']]
7+
# @param name [Pattern['^.+\.rules$']]
88
# The name of the udev rules to create
99
#
10-
# @param $ensure
10+
# @param ensure
1111
# Whether to drop a file or remove it
1212
#
1313
# @param path

Diff for: manifests/udevd.pp

+2-4
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
# @api private
2-
#
3-
# This class manages systemd's udev config
4-
#
5-
# https://www.freedesktop.org/software/systemd/man/udev.conf.html
2+
# @summary This class manages systemd's udev config
3+
# @see https://www.freedesktop.org/software/systemd/man/udev.conf.html
64
class systemd::udevd {
75
assert_private()
86

0 commit comments

Comments
 (0)