Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Correct puppet-strings documentation #192

Merged
merged 1 commit into from
Apr 26, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
628 changes: 453 additions & 175 deletions REFERENCE.md

Large diffs are not rendered by default.

20 changes: 10 additions & 10 deletions manifests/dropin_file.pp
Original file line number Diff line number Diff line change
Expand Up @@ -4,40 +4,40 @@
#
# @see systemd.unit(5)
#
# @attr name [Pattern['^[^/]+\.conf$']]
# @param name [Pattern['^[^/]+\.conf$']]
# The target unit file to create
#
# @attr path
# @param path
# The main systemd configuration path
#
# @attr selinux_ignore_defaults
# @param selinux_ignore_defaults
# If Puppet should ignore the default SELinux labels.
#
# @attr content
# @param content
# The full content of the unit file
#
# * Mutually exclusive with ``$source``
#
# @attr source
# @param source
# The ``File`` resource compatible ``source``
#
# * Mutually exclusive with ``$content``
#
# @attr target
# @param target
# If set, will force the file to be a symlink to the given target
#
# * Mutually exclusive with both ``$source`` and ``$content``
#
# @attr owner
# @param owner
# The owner to set on the dropin file
#
# @attr group
# @param group
# The group to set on the dropin file
#
# @attr mode
# @param mode
# The mode to set on the dropin file
#
# @attr show_diff
# @param show_diff
# Whether to show the diff when updating dropin file
#
define systemd::dropin_file (
Expand Down
6 changes: 2 additions & 4 deletions manifests/journald.pp
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# @api private
#
# This class manages and configures journald.
#
# https://www.freedesktop.org/software/systemd/man/journald.conf.html
# @summary This class manages and configures journald.
# @see https://www.freedesktop.org/software/systemd/man/journald.conf.html
class systemd::journald {
assert_private()

Expand Down
6 changes: 2 additions & 4 deletions manifests/logind.pp
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# @api private
#
# This class manages systemd's login manager configuration.
#
# https://www.freedesktop.org/software/systemd/man/logind.conf.html
# @summary This class manages systemd's login manager configuration.
# @see https://www.freedesktop.org/software/systemd/man/logind.conf.html
class systemd::logind {
assert_private()

Expand Down
3 changes: 1 addition & 2 deletions manifests/network.pp
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# -- Define: systemd::network
# Creates network config for systemd-networkd
# @summary Creates network config for systemd-networkd
define systemd::network (
Enum['file', 'absent'] $ensure = file,
Stdlib::Absolutepath $path = '/etc/systemd/network',
Expand Down
6 changes: 3 additions & 3 deletions manifests/resolved.pp
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# @api private
#
# This class provides an abstract way to trigger resolved.
# Each parameters correspond to resolved.conf(5):
# https://www.freedesktop.org/software/systemd/man/resolved.conf.html
# @summary This class provides an abstract way to trigger resolved.
# Each parameters correspond to resolved.conf(5)
# @see https://www.freedesktop.org/software/systemd/man/resolved.conf.html
#
# @param ensure
# The state that the ``resolved`` service should be in
Expand Down
6 changes: 3 additions & 3 deletions manifests/service_limits.pp
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@
#
# @see systemd.exec(5)
#
# @attr name [Pattern['^.+\.(service|socket|mount|swap)$']]
# @param name [Pattern['^.+\.(service|socket|mount|swap)$']]
# The name of the service that you will be modifying
#
# @param $ensure
# @param ensure
# Whether to drop a file or remove it
#
# @param path
Expand All @@ -24,7 +24,7 @@
# @param source
# A ``File`` resource compatible ``source``
#
# * Mutually exclusive with ``$limits``
# * Mutually exclusive with ``$limits``
#
# @param restart_service
# Restart the managed service after setting the limits
Expand Down
2 changes: 1 addition & 1 deletion manifests/timesyncd.pp
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
# @param ensure
# The state that the ``networkd`` service should be in
#
# @param $ntp_server
# @param ntp_server
# A space-separated list of NTP servers, will be combined with interface specific
# addresses from systemd-networkd. requires puppetlabs-inifile
#
Expand Down
6 changes: 3 additions & 3 deletions manifests/tmpfile.pp
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@
#
# @see systemd-tmpfiles(8)
#
# @attr name [Pattern['^[^/]+\.conf$']] (filename)
# @param name [Pattern['^[^/]+\.conf$']] (filename)
# The name of the tmpfile to create
#
# @param $ensure
# @param ensure
# Whether to drop a file or remove it
#
# @param path
Expand All @@ -21,7 +21,7 @@
# @param source
# A ``File`` resource compatible ``source``
#
# * Mutually exclusive with ``$limits``
# * Mutually exclusive with ``$limits``
#
define systemd::tmpfile (
Enum['present', 'absent', 'file'] $ensure = 'file',
Expand Down
4 changes: 2 additions & 2 deletions manifests/udev/rule.pp
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@
#
# @see udev(7)
#
# @attr name [Pattern['^.+\.rules$']]
# @param name [Pattern['^.+\.rules$']]
# The name of the udev rules to create
#
# @param $ensure
# @param ensure
# Whether to drop a file or remove it
#
# @param path
Expand Down
6 changes: 2 additions & 4 deletions manifests/udevd.pp
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# @api private
#
# This class manages systemd's udev config
#
# https://www.freedesktop.org/software/systemd/man/udev.conf.html
# @summary This class manages systemd's udev config
# @see https://www.freedesktop.org/software/systemd/man/udev.conf.html
class systemd::udevd {
assert_private()

Expand Down