Skip to content

Commit

Permalink
Correct puppet-strings documentation for unit_file
Browse files Browse the repository at this point in the history
puppet-strings uses @param rather than @attr. It also documents the
previously undocumented ensure parameter.
  • Loading branch information
ekohl committed Oct 23, 2019
1 parent 920dd63 commit 01f5fab
Showing 1 changed file with 14 additions and 11 deletions.
25 changes: 14 additions & 11 deletions manifests/unit_file.pp
Original file line number Diff line number Diff line change
Expand Up @@ -4,45 +4,48 @@
#
# @see systemd.unit(5)
#
# @attr name [Pattern['^.+\.(service|socket|device|mount|automount|swap|target|path|timer|slice|scope)$']]
# @param name [Pattern['^.+\.(service|socket|device|mount|automount|swap|target|path|timer|slice|scope)$']]
# The target unit file to create
#
# * Must not contain ``/``
#
# @attr path
# @param ensure
# The state of the unit file to ensure
#
# @param path
# The main systemd configuration path
#
# @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 unit file
#
# @attr group
# @param group
# The group to set on the unit file
#
# @attr mode
# @param mode
# The mode to set on the unit file
#
# @attr show_diff
# @param show_diff
# Whether to show the diff when updating unit file
#
# @attr enable
# @param enable
# If set, will manage the unit enablement status.
#
# @attr active
# @param active
# If set, will manage the state of the unit.
#
define systemd::unit_file(
Expand Down

0 comments on commit 01f5fab

Please sign in to comment.