diff --git a/REFERENCE.md b/REFERENCE.md index 62e19e97..668f2e40 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -12,7 +12,7 @@ _Public Classes_ _Private Classes_ * `selinux::build`: Configure the system for module building -* `selinux::config`: Configure the system to use SELinux on the system. It is included in the main class ::selinux +* `selinux::config`: Configure the system to use SELinux on the system. * `selinux::package`: Manages additional packages required to support some of the functions. * `selinux::params`: This class provides default parameters for the selinux class * `selinux::refpolicy_package`: Manages additional packages required to support some of the functions. @@ -94,7 +94,7 @@ Data type: `String` sets the name for the selinux tools package Default value: OS dependent (see params.pp) -Default value: $::selinux::params::package_name +Default value: $selinux::params::package_name ##### `refpolicy_package_name` @@ -112,7 +112,7 @@ Data type: `Stdlib::Absolutepath` directory where modules are built. Defaults to `$vardir/puppet-selinux` -Default value: $::selinux::params::module_build_root +Default value: $selinux::params::module_build_root ##### `default_builder` @@ -182,7 +182,7 @@ Manage the state of an SELinux boolean. ```puppet selinux::boolean{ 'named_write_master_zones': - ensure => 'on', + ensure => 'on', } ``` @@ -190,7 +190,7 @@ selinux::boolean{ 'named_write_master_zones': ```puppet selinux::boolean{ 'named_write_master_zones': - ensure => 'off', + ensure => 'off', } ``` @@ -284,8 +284,8 @@ selinux::fcontext::equivalence ```puppet selinux::fcontext{'set-mysql-log-context': - seltype => "mysqld_log_t", - pathspec => "/u01/log/mysql(/.*)?", + seltype => 'mysqld_log_t', + pathspec => '/u01/log/mysql(/.*)?', } ``` diff --git a/manifests/boolean.pp b/manifests/boolean.pp index 58b0986c..995a3a71 100644 --- a/manifests/boolean.pp +++ b/manifests/boolean.pp @@ -1,13 +1,13 @@ -# Manage the state of an SELinux boolean. +# @summary Manage the state of an SELinux boolean. # # @example Enable `named_write_master_zones` boolean # selinux::boolean{ 'named_write_master_zones': -# ensure => 'on', +# ensure => 'on', # } # # @example Ensure `named_write_master_zones` boolean is disabled # selinux::boolean{ 'named_write_master_zones': -# ensure => 'off', +# ensure => 'off', # } # # @param ensure Set to on or off diff --git a/manifests/config.pp b/manifests/config.pp index 16d8921b..0b71efae 100644 --- a/manifests/config.pp +++ b/manifests/config.pp @@ -1,6 +1,6 @@ -# Configure the system to use SELinux on the system. +# @summary Configure the system to use SELinux on the system. # -# It is included in the main class ::selinux +# It is included in the main class `selinux` # # @param mode See main class # @param type See main class diff --git a/manifests/fcontext.pp b/manifests/fcontext.pp index 1ddabd29..41858271 100644 --- a/manifests/fcontext.pp +++ b/manifests/fcontext.pp @@ -4,7 +4,7 @@ # # @example Add a file-context for mysql log files at non standard location # selinux::fcontext{'set-mysql-log-context': -# seltype => 'mysqld_log_t', +# seltype => 'mysqld_log_t', # pathspec => '/u01/log/mysql(/.*)?', # } # diff --git a/manifests/fcontext/equivalence.pp b/manifests/fcontext/equivalence.pp index 3f227e33..d1670940 100644 --- a/manifests/fcontext/equivalence.pp +++ b/manifests/fcontext/equivalence.pp @@ -1,4 +1,4 @@ -# Manage SELinux fcontext equivalences +# @summary Manage SELinux fcontext equivalences # # @param path the path to define and equivalence for. Default: Resource title # @param target the path that this resource will be equivalent to. diff --git a/manifests/package.pp b/manifests/package.pp index c2da1ebf..df64188d 100644 --- a/manifests/package.pp +++ b/manifests/package.pp @@ -1,4 +1,4 @@ -# Manages additional packages required to support some of the functions. +# @summary Manages additional packages required to support some of the functions. # # @api private #