Update stdlib
[mirror/dsa-puppet.git] / 3rdparty / modules / stdlib / lib / puppet / parser / functions / deprecation.rb
1 module Puppet::Parser::Functions
2   newfunction(:deprecation, :doc => <<-EOS
3   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.).
4 EOS
5   ) do |arguments|
6
7     raise(Puppet::ParseError, "deprecation: Wrong number of arguments given (#{arguments.size} for 2)") unless arguments.size == 2
8
9     key = arguments[0]
10     message = arguments[1]
11
12     if ENV['STDLIB_LOG_DEPRECATIONS'] == "true"
13       warning("deprecation. #{key}. #{message}")
14     end
15   end
16 end