Sha256: b71ac15e0d59c89665f410c10d30ba6a5589c31305b032a068992ba8f9ce13bd

Contents?: true

Size: 1 KB

Versions: 20

Compression:

Stored size: 1 KB

Contents

# frozen_string_literal: true
Puppet::Util::Reference.newreference :metaparameter, :doc => "All Puppet metaparameters and all their details" do
  str = %{

Metaparameters are attributes that work with any resource type, including custom
types and defined types.

In general, they affect _Puppet's_ behavior rather than the desired state of the
resource. Metaparameters do things like add metadata to a resource (`alias`,
`tag`), set limits on when the resource should be synced (`require`, `schedule`,
etc.), prevent Puppet from making changes (`noop`), and change logging verbosity
(`loglevel`).

## Available Metaparameters

}
  begin
    params = []
    Puppet::Type.eachmetaparam { |param|
      params << param
    }

    params.sort_by(&:to_s).each { |param|
      str << markdown_header(param.to_s, 3)
      str << scrub(Puppet::Type.metaparamdoc(param))
      str << "\n\n"
    }
  rescue => detail
    Puppet.log_exception(detail, _("incorrect metaparams: %{detail}") % { detail: detail })
    exit(1)
  end

  str
end

Version data entries

20 entries across 20 versions & 1 rubygems

Version Path
puppet-8.3.0 lib/puppet/reference/metaparameter.rb
puppet-8.3.0-x86-mingw32 lib/puppet/reference/metaparameter.rb
puppet-8.3.0-x64-mingw32 lib/puppet/reference/metaparameter.rb
puppet-8.3.0-universal-darwin lib/puppet/reference/metaparameter.rb
puppet-8.3.1 lib/puppet/reference/metaparameter.rb
puppet-8.3.1-x86-mingw32 lib/puppet/reference/metaparameter.rb
puppet-8.3.1-x64-mingw32 lib/puppet/reference/metaparameter.rb
puppet-8.3.1-universal-darwin lib/puppet/reference/metaparameter.rb
puppet-8.2.0 lib/puppet/reference/metaparameter.rb
puppet-8.2.0-x86-mingw32 lib/puppet/reference/metaparameter.rb
puppet-8.2.0-x64-mingw32 lib/puppet/reference/metaparameter.rb
puppet-8.2.0-universal-darwin lib/puppet/reference/metaparameter.rb
puppet-8.1.0 lib/puppet/reference/metaparameter.rb
puppet-8.1.0-x86-mingw32 lib/puppet/reference/metaparameter.rb
puppet-8.1.0-x64-mingw32 lib/puppet/reference/metaparameter.rb
puppet-8.1.0-universal-darwin lib/puppet/reference/metaparameter.rb
puppet-8.0.1 lib/puppet/reference/metaparameter.rb
puppet-8.0.1-x86-mingw32 lib/puppet/reference/metaparameter.rb
puppet-8.0.1-x64-mingw32 lib/puppet/reference/metaparameter.rb
puppet-8.0.1-universal-darwin lib/puppet/reference/metaparameter.rb