diff options
Diffstat (limited to 'lib/puppet/parser/functions/versioncmp.rb')
| -rw-r--r-- | lib/puppet/parser/functions/versioncmp.rb | 15 |
1 files changed, 9 insertions, 6 deletions
diff --git a/lib/puppet/parser/functions/versioncmp.rb b/lib/puppet/parser/functions/versioncmp.rb index 6091e0923..a06866876 100644 --- a/lib/puppet/parser/functions/versioncmp.rb +++ b/lib/puppet/parser/functions/versioncmp.rb @@ -4,19 +4,19 @@ require 'puppet/util/package' Puppet::Parser::Functions::newfunction( :versioncmp, :type => :rvalue, - :doc => "Compares two versions + :doc => "Compares two version numbers. Prototype: \$result = versioncmp(a, b) -Where a and b are arbitrary version strings +Where a and b are arbitrary version strings. -This functions returns a number: +This function returns: -* Greater than 0 if version a is greater than version b -* Equal to 0 if both version are equals -* Less than 0 if version a is less than version b +* `1` if version a is greater than version b +* `0` if the versions are equal +* `-1` if version a is less than version b Example: @@ -24,6 +24,9 @@ Example: notice('2.6-1 is > than 2.4.5') } +This function uses the same version comparison algorithm used by Puppet's +`package` type. + ") do |args| unless args.length == 2 |