Puppet Function: deprecation

Defined in:
puppet/modules/stdlib/lib/puppet/parser/functions/deprecation.rb
Function type:
Ruby 3.x API

Overview

deprecation() ⇒ Any

Function to print deprecation warnings (this is the 3.X version of it), The uniqueness key - can appear once. The msg is the message text including any positional information that is formatted by the user/caller of the method.).

Returns:

  • (Any) 


2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
 
# File 'puppet/modules/stdlib/lib/puppet/parser/functions/deprecation.rb', line 2

newfunction(:deprecation, :doc => <<-EOS
Function to print deprecation warnings (this is the 3.X version of it), The uniqueness key - can appear once. The msg is the message text including any positional information that is formatted by the user/caller of the method.).
EOS
) do |arguments|

  raise(Puppet::ParseError, "deprecation: Wrong number of arguments " +
    "given (#{arguments.size} for 2)") unless arguments.size == 2

  key = arguments[0]
  message = arguments[1]

  if ENV['STDLIB_LOG_DEPRECATIONS'] == "true"
    warning("deprecation. #{key}. #{message}")
  end
end