puppet 6.22.1-x64-mingw32 → 6.23.0-x64-mingw32

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '049a5917d94b3ac0a7fd264febc60514f8994fd64470565a9c66ec6b003a935b'
-  data.tar.gz: 40d7545a3870dca5da3e4c631e6707dcb8db2ccb798fd39f7e4cfc0c7fdddcdb
+  metadata.gz: '039f51c72f429dd07abf7008f97a11344cd150d8070ecd3012c19368beb31569'
+  data.tar.gz: 26d8e4acf456f6e09a541359a5b24c449a39aa1db09b0c911aea2db05a861c75
 SHA512:
-  metadata.gz: d02e151f5f7adfeae5627cb749d38e553bebddc58d8912d016d66cb17776b280dd127b31f457ac2e962e0a2563486323ef9c7f244c93cb5c30ec7008b4751db1
-  data.tar.gz: fcc93c47f9ed12b437efe595c9f8b34c38886fc4238286c23b55dd77e1fd212f037102e7b5275cb5db996073fb8f55ddf379c8fabebe0849cdc1b67d4ad49a2b
+  metadata.gz: b045dd0cb388f971529bf5fe20d96b570c06ecfc5406a249f51c6030223548b00b19676a6b0d0aaa53259e2acebb67a9738dd95bac2a162ce869a1be14d26250
+  data.tar.gz: 6cb9a599d7ac5987eac8fd726418f9642a80e263aa491c1ee094c4a6177f9b897d6d1b82d64c27b5f497399a1f41900f7b33e09553f88c31acb07961098ae750

data/Gemfile.lock

@@ -1,9 +1,9 @@
 GIT
-  remote: git://github.com/ciprianbadescu/packaging
-  revision: 5f8d2bda941abfeeb8fb1731c9b1dd4d108f5d33
-  branch: maint/windows-signing
+  remote: git://github.com/puppetlabs/packaging
+  revision: 9ddc3c730023911b5ef015dc55a4d2e9a55e4a6c
+  branch: 1.0.x
   specs:
-    packaging (0.99.49.171.g5f8d2bd)
+    packaging (0.99.77)
       artifactory (~> 2)
       csv (= 3.1.5)
       rake (>= 12.3)
@@ -12,7 +12,7 @@ GIT
 PATH
   remote: .
   specs:
-    puppet (6.22.1)
+    puppet (6.23.0)
       CFPropertyList (~> 2.2)
       concurrent-ruby (~> 1.0)
       deep_merge (~> 1.0)
@@ -33,18 +33,18 @@ GEM
     artifactory (2.8.2)
     ast (2.4.2)
     coderay (1.1.3)
-    concurrent-ruby (1.1.8)
+    concurrent-ruby (1.1.9)
     crack (0.4.5)
       rexml
     csv (3.1.5)
     deep_merge (1.2.1)
     diff-lcs (1.4.4)
     docopt (0.6.1)
-    facter (4.1.1)
+    facter (4.2.1)
       hocon (~> 1.3)
       thor (>= 1.0.1, < 2.0)
     fast_gettext (1.1.2)
-    ffi (1.15.0)
+    ffi (1.15.1)
     gettext (3.2.9)
       locale (>= 2.0.5)
       text (>= 1.3.0)
@@ -54,7 +54,7 @@ GEM
       locale
     hashdiff (1.0.1)
     hiera (3.7.0)
-    hiera-eyaml (3.2.1)
+    hiera-eyaml (3.2.2)
       highline
       optimist
     highline (2.0.3)
@@ -79,16 +79,16 @@ GEM
       coderay (~> 1.1)
       method_source (~> 1.0)
     public_suffix (4.0.6)
-    puppet-resource_api (1.8.13)
+    puppet-resource_api (1.8.14)
       hocon (>= 1.0)
-    puppetserver-ca (1.9.4)
+    puppetserver-ca (1.9.5)
       facter (>= 2.0.1, < 5)
     racc (1.4.9)
     rainbow (2.2.2)
       rake
     rake (12.3.3)
     rdiscount (2.2.0.2)
-    rdoc (6.3.0)
+    rdoc (6.3.1)
     release-metrics (1.1.0)
       csv
       docopt
@@ -124,12 +124,12 @@ GEM
       rubocop (~> 0.49.0)
     ruby-prof (1.4.3)
     ruby-progressbar (1.11.0)
-    semantic_puppet (1.0.3)
+    semantic_puppet (1.0.4)
     text (1.3.1)
     thor (1.1.0)
     unicode-display_width (1.7.0)
     vcr (5.1.0)
-    webmock (3.12.2)
+    webmock (3.13.0)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)

data/ext/osx/puppet.plist

@@ -26,5 +26,7 @@
         <string>/var/log/puppetlabs/puppet/puppet.log</string>
         <key>StandardOutPath</key>
         <string>/var/log/puppetlabs/puppet/puppet.log</string>
+        <key>SessionCreate</key>
+        <true />
 </dict>
 </plist>

data/lib/puppet/application/agent.rb

@@ -133,9 +133,12 @@ Some flags are meant specifically for interactive use --- in particular,
 'test', 'tags' and 'fingerprint' are useful.
 
 '--test' runs once in the foreground with verbose logging, then exits.
-It also exits if it can't get a valid catalog. `--test` includes the '--detailed-exitcodes' option by default and exits with one of the following exit codes:
+It also exits if it can't get a valid catalog. `--test` includes the 
+'--detailed-exitcodes' option by default and exits with one of the following 
+exit codes:
 
-* 0: The run succeeded with no changes or failures; the system was already in the desired state.
+* 0: The run succeeded with no changes or failures; the system was already in 
+     the desired state.
 * 1: The run failed, or wasn't attempted due to another run already in progress.
 * 2: The run succeeded, and some resources were changed.
 * 4: The run succeeded, and some resources failed.
@@ -246,7 +249,9 @@ generated by running puppet agent with '--genconfig'.
   'puppet agent' exits after executing this.
   
 *  --evaltrace:
-  Logs each resource as it is being evaluated. This allows you to interactively see exactly what is being done. (This is a Puppet setting, and can go in puppet.conf. Note the special 'no-' prefix for boolean settings on the command line.)
+  Logs each resource as it is being evaluated. This allows you to interactively
+  see exactly what is being done. (This is a Puppet setting, and can go in
+  puppet.conf. Note the special 'no-' prefix for boolean settings on the command line.)
 
 * --fingerprint:
   Display the current certificate or certificate signing request
@@ -267,7 +272,8 @@ generated by running puppet agent with '--genconfig'.
   service), 'eventlog' (the Windows Event Log), 'console', or the path to a log
   file. If debugging or verbosity is enabled, this defaults to 'console'.
   Otherwise, it defaults to 'syslog' on POSIX systems and 'eventlog' on Windows.
-  Multiple destinations can be set using a comma separated list (eg: `/path/file1,console,/path/file2`)"
+  Multiple destinations can be set using a comma separated list 
+  (eg: `/path/file1,console,/path/file2`)"
 
   A path ending with '.json' will receive structured output in JSON format. The
   log file will not have an ending ']' automatically written to it due to the
@@ -310,7 +316,8 @@ generated by running puppet agent with '--genconfig'.
   'no-splay', and 'show_diff'.
   
 * --trace
-  Prints stack traces on some errors. (This is a Puppet setting, and can go in puppet.conf. Note the special 'no-' prefix for boolean settings on the command line.)
+  Prints stack traces on some errors. (This is a Puppet setting, and can go in
+  puppet.conf. Note the special 'no-' prefix for boolean settings on the command line.)
 
 * --verbose:
   Turn on verbose reporting.

data/lib/puppet/application/apply.rb

@@ -113,7 +113,8 @@ configuration options by running puppet with
   Where to send log messages. Choose between 'syslog' (the POSIX syslog
   service), 'eventlog' (the Windows Event Log), 'console', or the path to a log
   file. Defaults to 'console'.
-  Multiple destinations can be set using a comma separated list (eg: `/path/file1,console,/path/file2`)"
+  Multiple destinations can be set using a comma separated list
+  (eg: `/path/file1,console,/path/file2`)"
 
   A path ending with '.json' will receive structured output in JSON format. The
   log file will not have an ending ']' automatically written to it due to the

data/lib/puppet/application/device.rb

@@ -155,7 +155,8 @@ you can specify '--server <servername>' as an argument.
   Where to send log messages. Choose between 'syslog' (the POSIX syslog
   service), 'console', or the path to a log file. If debugging or verbosity is
   enabled, this defaults to 'console'. Otherwise, it defaults to 'syslog'.
-  Multiple destinations can be set using a comma separated list (eg: `/path/file1,console,/path/file2`)"
+  Multiple destinations can be set using a comma separated list
+  (eg: `/path/file1,console,/path/file2`)"
 
   A path ending with '.json' will receive structured output in JSON format. The
   log file will not have an ending ']' automatically written to it due to the

data/lib/puppet/application/resource.rb

@@ -101,7 +101,8 @@ configuration options can also be generated by running puppet with
   Print extra information.
 
 * --to_yaml:
-  Output found resources in yaml format, suitable to use with Hiera and create_resources.
+  Output found resources in yaml format, suitable to use with Hiera and
+  create_resources.
 
 EXAMPLE
 -------

data/lib/puppet/application/script.rb

@@ -71,7 +71,8 @@ configuration options can also be generated by running puppet with
   Where to send log messages. Choose between 'syslog' (the POSIX syslog
   service), 'eventlog' (the Windows Event Log), 'console', or the path to a log
   file. Defaults to 'console'.
-  Multiple destinations can be set using a comma separated list (eg: `/path/file1,console,/path/file2`)"
+  Multiple destinations can be set using a comma separated list
+  (eg: `/path/file1,console,/path/file2`)"
 
   A path ending with '.json' will receive structured output in JSON format. The
   log file will not have an ending ']' automatically written to it due to the

data/lib/puppet/configurer/downloader.rb

@@ -73,7 +73,8 @@ class Puppet::Configurer::Downloader
       :purge => true,
       :force => true,
       :backup => false,
-      :noop => false
+      :noop => false,
+      :max_files => -1
     }
     if !Puppet::Util::Platform.windows?
       defargs[:owner] = Process.uid

data/lib/puppet/defaults.rb

@@ -878,8 +878,8 @@ names.
 **Note:** The list of alternate names is locked in when the server's
 certificate is signed. If you need to change the list later, you can't just
 change this setting; you also need to regenerate the certificate. For more
-information on that process, see the [cert regen docs]
-(https://puppet.com/docs/puppet/latest/ssl_regenerate_certificates.html).
+information on that process, see the 
+[cert regen docs](https://puppet.com/docs/puppet/latest/ssl_regenerate_certificates.html).
 
 To see all the alternate names your servers are using, log into your CA server
 and run `puppetserver ca list --all`, then check the output for `(alt names: ...)`.
@@ -1517,7 +1517,9 @@ EOT
         See the report reference for information on the built-in report
         handlers; custom report handlers can also be loaded from modules.
         (Report handlers are loaded from the lib directory, at
-        `puppet/reports/NAME.rb`.)",
+        `puppet/reports/NAME.rb`.)
+
+        To turn off reports entirely, set this to `none`",
     },
     :reportdir => {
       :default => "$vardir/reports",

data/lib/puppet/file_serving/fileset.rb

@@ -5,7 +5,7 @@ require 'puppet/file_serving/metadata'
 # Operate recursively on a path, returning a set of file paths.
 class Puppet::FileServing::Fileset
   attr_reader :path, :ignore, :links
-  attr_accessor :recurse, :recurselimit, :checksum_type
+  attr_accessor :recurse, :recurselimit, :max_files, :checksum_type
 
   # Produce a hash of files, with merged so that earlier files
   # with the same postfix win.  E.g., /dir1/subfile beats /dir2/subfile.
@@ -40,6 +40,7 @@ class Puppet::FileServing::Fileset
     self.links = :manage
     @recurse = false
     @recurselimit = :infinite
+    @max_files = 0
 
     if options.is_a?(Puppet::Indirector::Request)
       initialize_from_request(options)
@@ -58,6 +59,17 @@ class Puppet::FileServing::Fileset
   # level deep, which Find doesn't do.
   def files
     files = perform_recursion
+    soft_max_files = 1000
+
+    # munged_max_files is needed since puppet http handler is keeping negative numbers as strings
+    # https://github.com/puppetlabs/puppet/blob/main/lib/puppet/network/http/handler.rb#L196-L197
+    munged_max_files = max_files == '-1' ? -1 : max_files
+
+    if munged_max_files > 0 && files.size > munged_max_files
+      raise Puppet::Error.new _("The directory '%{path}' contains %{entries} entries, which exceeds the limit of %{munged_max_files} specified by the max_files parameter for this resource. The limit may be increased, but be aware that large number of file resources can result in excessive resource consumption and degraded performance. Consider using an alternate method to manage large directory trees") % { path: path, entries: files.size, munged_max_files: munged_max_files }
+    elsif munged_max_files == 0 && files.size > soft_max_files
+      Puppet.warning _("The directory '%{path}' contains %{entries} entries, which exceeds the default soft limit %{soft_max_files} and may cause excessive resource consumption and degraded performance. To remove this warning set a value for `max_files` parameter or consider using an alternate method to manage large directory trees") % { path: path, entries: files.size, soft_max_files: soft_max_files }
+    end
 
     # Now strip off the leading path, so each file becomes relative, and remove
     # any slashes that might end up at the beginning of the path.
@@ -96,7 +108,7 @@ class Puppet::FileServing::Fileset
   end
 
   def initialize_from_request(request)
-    [:links, :ignore, :recurse, :recurselimit, :checksum_type].each do |param|
+    [:links, :ignore, :recurse, :recurselimit, :max_files, :checksum_type].each do |param|
       if request.options.include?(param) # use 'include?' so the values can be false
         value = request.options[param]
       elsif request.options.include?(param.to_s)

data/lib/puppet/functions/all.rb

@@ -51,7 +51,7 @@
 # notice $data.all |$key, $value| { $value % 10 == 0  and $key =~ /^abc/ }
 # ```
 #
-# Would notice true.
+# Would notice `true`.
 #
 # For an general examples that demonstrates iteration, see the Puppet
 # [iteration](https://puppet.com/docs/puppet/latest/lang_iteration.html)

data/lib/puppet/functions/camelcase.rb

@@ -3,7 +3,7 @@
 # This function is compatible with the stdlib function with the same name.
 #
 # The function does the following:
-# * For a `String` the conversion replaces all combinations of *_<char>* with an upcased version of the
+# * For a `String` the conversion replaces all combinations of `*_<char>*` with an upcased version of the
 #   character following the _.  This is done using Ruby system locale which handles some, but not all
 #   special international up-casing rules (for example German double-s ß is upcased to "Ss").
 # * For an `Iterable[Variant[String, Numeric]]` (for example an `Array`) each value is capitalized and the conversion is not recursive.

data/lib/puppet/functions/capitalize.rb

@@ -18,14 +18,14 @@
 # 'hello'.capitalize()
 # upcase('hello')
 # ```
-# Would both result in "Hello"
+# Would both result in `"Hello"`
 #
 # @example Capitalizing strings in an Array
 # ```puppet
 # ['abc', 'bcd'].capitalize()
 # capitalize(['abc', 'bcd'])
 # ```
-# Would both result in ['Abc', 'Bcd']
+# Would both result in `['Abc', 'Bcd']`
 #
 Puppet::Functions.create_function(:capitalize) do
 

data/lib/puppet/functions/downcase.rb

@@ -22,14 +22,14 @@
 # 'HELLO'.downcase()
 # downcase('HEllO')
 # ```
-# Would both result in "hello"
+# Would both result in `"hello"`
 #
 # @example Converting an Array to lower case
 # ```puppet
 # ['A', 'B'].downcase()
 # downcase(['A', 'B'])
 # ```
-# Would both result in ['a', 'b']
+# Would both result in `['a', 'b']`
 #
 # @example Converting a Hash to lower case
 # ```puppet

data/lib/puppet/functions/get.rb

@@ -23,20 +23,20 @@
 # #get($facts, 'os.family')
 # $facts.get('os.family')
 # ```
-# Would both result in the value of $facts['os']['family']
+# Would both result in the value of `$facts['os']['family']`
 #
 # @example Getting the value from an expression
 # ```puppet
 # get([1,2,[{'name' =>'waldo'}]], '2.0.name')
 # ```
-# Would result in 'waldo'
+# Would result in `'waldo'`
 #
 # @example Using a default value
 # ```puppet
 # get([1,2,[{'name' =>'waldo'}]], '2.1.name', 'not waldo')
 #
 # ```
-# Would result in 'not waldo'
+# Would result in `'not waldo'`
 #
 # @example Quoting a key with period
 # ```puppet
@@ -128,8 +128,8 @@ Puppet::Functions.create_function(:get, Puppet::Functions::InternalFunction) do
 
     # Note: split_key always processes the initial segment as a string even if it could be an integer.
     # This since it is designed for lookup keys. For a numeric first segment
-    # like '0.1' the wanted result is [0,1], not ["0", 1]. The workaround here is to
-    # prefix the navigation with "x." thus giving split_key a first segment that is a string.
+    # like '0.1' the wanted result is `[0,1]`, not `["0", 1]`. The workaround here is to
+    # prefix the navigation with `"x."` thus giving split_key a first segment that is a string.
     # The fake segment is then dropped.
     segments = split_key("x." + navigation) {|err| _("Syntax error in dotted-navigation string")}
     segments.shift

data/lib/puppet/functions/group_by.rb

@@ -4,14 +4,22 @@
 # and the values are arrays of elements in the collection that correspond to the key.
 Puppet::Functions.create_function(:group_by) do
   # @param collection A collection of things to group.
-  # @example Group array of strings by length, results in e.g. { 1 => [a, b], 2 => [ab] }
+  # @example Group array of strings by length, results in e.g. `{ 1 => [a, b], 2 => [ab] }`
+  #   ```puppet
   #   [a, b, ab].group_by |$s| { $s.length }
-  # @example Group array of strings by length and index, results in e.g. {1 => ['a'], 2 => ['b', 'ab']}
+  #   ```
+  # @example Group array of strings by length and index, results in e.g. `{1 => ['a'], 2 => ['b', 'ab']}`
+  #   ```puppet
   #   [a, b, ab].group_by |$i, $s| { $i%2 + $s.length }
-  # @example Group hash iterating by key-value pair, results in e.g. { 2 => [['a', [1, 2]]], 1 => [['b', [1]]] }
+  #   ```
+  # @example Group hash iterating by key-value pair, results in e.g. `{ 2 => [['a', [1, 2]]], 1 => [['b', [1]]] }`
+  #   ```puppet
   #   { a => [1, 2], b => [1] }.group_by |$kv| { $kv[1].length }
-  # @example Group hash iterating by key and value, results in e.g. { 2 => [['a', [1, 2]]], 1 => [['b', [1]]] }
-  #   { a => [1, 2], b => [1] }.group_by |$k, $v| { $v.length }
+  #   ```
+  # @example Group hash iterating by key and value, results in e.g. `{ 2 => [['a', [1, 2]]], 1 => [['b', [1]]] }`
+  #   ```puppet
+  #    { a => [1, 2], b => [1] }.group_by |$k, $v| { $v.length }
+  #   ```
   dispatch :group_by_1 do
     required_param 'Collection', :collection
     block_param 'Callable[1,1]', :block

data/lib/puppet/functions/lest.rb

@@ -23,7 +23,7 @@
 #  .lest || { fail("no value for $data[a][b][c]" }
 # ```
 #
-# Would fail the operation because $data[a][b][c] results in `undef`
+# Would fail the operation because `$data[a][b][c]` results in `undef`
 # (there is no `b` key in `a`).
 #
 # In contrast - this example:

data/lib/puppet/functions/new.rb

@@ -51,7 +51,7 @@
 # The following sections show the arguments and conversion rules
 # per data type built into the Puppet Type System.
 #
-# ### Conversion to Optional[T] and NotUndef[T]
+# ### Conversion to `Optional[T]` and `NotUndef[T]`
 #
 # Conversion to these data types is the same as a conversion to the type argument `T`.
 # In the case of `Optional[T]` it is accepted that the argument to convert may be `undef`.
@@ -85,13 +85,13 @@
 #   * `0` as radix 8.
 #   * All others are decimal.
 # * Conversion from `String` accepts an optional sign in the string.
-# * For hexadecimal (radix 16) conversion an optional leading "0x", or "0X" is accepted.
-# * For octal (radix 8) an optional leading "0" is accepted.
-# * For binary (radix 2) an optional leading "0b" or "0B" is accepted.
+# * For hexadecimal (radix 16) conversion an optional leading `"0x"`, or `"0X"` is accepted.
+# * For octal (radix 8) an optional leading `"0"` is accepted.
+# * For binary (radix 2) an optional leading `"0b"` or `"0B"` is accepted.
 # * When `radix` is set to `default`, the conversion is based on the leading.
-#   characters in the string. A leading "0" for radix 8, a leading "0x", or "0X" for
-#   radix 16, and leading "0b" or "0B" for binary.
-# * Conversion from `Boolean` results in 0 for `false` and 1 for `true`.
+#   characters in the string. A leading `"0"` for radix 8, a leading `"0x"`, or `"0X"` for
+#   radix 16, and leading `"0b"` or `"0B"` for binary.
+# * Conversion from `Boolean` results in `0` for `false` and `1` for `true`.
 # * Conversion from `Integer`, `Float`, and `Boolean` ignores the radix.
 # * `Float` value fractions are truncated (no rounding).
 # * When `abs` is set to `true`, the result will be an absolute integer.
@@ -119,9 +119,9 @@
 # ```
 #
 # * For an integer, the floating point fraction of `.0` is added to the value.
-# * A `Boolean` `true` is converted to 1.0, and a `false` to 0.0
+# * A `Boolean` `true` is converted to `1.0`, and a `false` to `0.0`.
 # * In `String` format, integer prefixes for hex and binary are understood (but not octal since
-#   floating point in string format may start with a '0').
+#   floating point in string format may start with a `'0'`).
 # * When `abs` is set to `true`, the result will be an absolute floating point value.
 #
 # ### Conversion to Numeric
@@ -139,7 +139,7 @@
 # * If the value has a decimal period, or if given in scientific notation
 #   (e/E), the result is a `Float`, otherwise the value is an `Integer`. The
 #   conversion from `String` always uses a radix based on the prefix of the string.
-# * Conversion from `Boolean` results in 0 for `false` and 1 for `true`.
+# * Conversion from `Boolean` results in `0` for `false` and `1` for `true`.
 # * When `abs` is set to `true`, the result will be an absolute `Float`or `Integer` value.
 #
 # @example Converting to Numeric in different ways
@@ -225,7 +225,7 @@
 # )
 # ```
 #
-# The directive consists of a percent (%) character, zero or more flags, optional minimum field width and
+# The directive consists of a percent (`%`) character, zero or more flags, optional minimum field width and
 # a conversion specifier as follows:
 # ```
 # %[Flags][Width]Conversion
@@ -291,7 +291,7 @@
 # argument is omitted, an array of default formats will be used.
 #
 # A third optional timezone argument can be provided. The first argument will then be parsed as if it represents a local time in that
-# timezone. The timezone can be any timezone that is recognized when using the '%z' or '%Z' formats, or the word 'current', in which
+# timezone. The timezone can be any timezone that is recognized when using the `'%z'` or `'%Z'` formats, or the word `'current'`, in which
 # case the current timezone of the evaluating process will be used. The timezone argument is case insensitive.
 #
 # The default timezone, when no argument is provided, or when using the keyword `default`, is 'UTC'.
@@ -336,7 +336,7 @@
 # | 0     | Use zeros for padding
 # | #     | Change names to upper-case or change case of am/pm
 # | ^     | Use uppercase
-# | :     | Use colons for %z
+# | :     | Use colons for `%z`
 #
 # ##### Format directives (names and padding can be altered using flags):
 #
@@ -345,48 +345,48 @@
 # | Format | Meaning |
 # | ------ | ------- |
 # | Y | Year with century, zero-padded to at least 4 digits |
-# | C | year / 100 (rounded down such as 20 in 2009) |
-# | y | year % 100 (00..99) |
-# | m | Month of the year, zero-padded (01..12) |
-# | B | The full month name ("January") |
-# | b | The abbreviated month name ("Jan") |
-# | h | Equivalent to %b |
-# | d | Day of the month, zero-padded (01..31) |
-# | e | Day of the month, blank-padded ( 1..31) |
-# | j | Day of the year (001..366) |
+# | C | year / 100 (rounded down such as `20` in `2009`) |
+# | y | year % 100 (`00..99`) |
+# | m | Month of the year, zero-padded (`01..12`) |
+# | B | The full month name (`"January"`) |
+# | b | The abbreviated month name (`"Jan"`) |
+# | h | Equivalent to `%b` |
+# | d | Day of the month, zero-padded (`01..31`) |
+# | e | Day of the month, blank-padded (`1..31`) |
+# | j | Day of the year (`001..366`) |
 #
 # **Time (Hour, Minute, Second, Subsecond):**
 #
 # | Format | Meaning |
 # | ------ | ------- |
-# | H | Hour of the day, 24-hour clock, zero-padded (00..23) |
-# | k | Hour of the day, 24-hour clock, blank-padded ( 0..23) |
-# | I | Hour of the day, 12-hour clock, zero-padded (01..12) |
-# | l | Hour of the day, 12-hour clock, blank-padded ( 1..12) |
-# | P | Meridian indicator, lowercase ("am" or "pm") |
-# | p | Meridian indicator, uppercase ("AM" or "PM") |
-# | M | Minute of the hour (00..59) |
-# | S | Second of the minute (00..60) |
-# | L | Millisecond of the second (000..999). Digits under millisecond are truncated to not produce 1000 |
+# | H | Hour of the day, 24-hour clock, zero-padded (`00..23`) |
+# | k | Hour of the day, 24-hour clock, blank-padded (`0..23`) |
+# | I | Hour of the day, 12-hour clock, zero-padded (`01..12`) |
+# | l | Hour of the day, 12-hour clock, blank-padded (`1..12`) |
+# | P | Meridian indicator, lowercase (`"am"` or `"pm"`) |
+# | p | Meridian indicator, uppercase (`"AM"` or `"PM"`) |
+# | M | Minute of the hour (`00..59`) |
+# | S | Second of the minute (`00..60`) |
+# | L | Millisecond of the second (`000..999`). Digits under millisecond are truncated to not produce 1000 |
 # | N | Fractional seconds digits, default is 9 digits (nanosecond). Digits under a specified width are truncated to avoid carry up |
 #
 # **Time (Hour, Minute, Second, Subsecond):**
 #
 # | Format | Meaning |
 # | ------ | ------- |
-# | z   | Time zone as hour and minute offset from UTC (e.g. +0900) |
-# | :z  | hour and minute offset from UTC with a colon (e.g. +09:00) |
-# | ::z | hour, minute and second offset from UTC (e.g. +09:00:00) |
+# | z   | Time zone as hour and minute offset from UTC (e.g. `+0900`) |
+# | :z  | hour and minute offset from UTC with a colon (e.g. `+09:00`) |
+# | ::z | hour, minute and second offset from UTC (e.g. `+09:00:00`) |
 # | Z   | Abbreviated time zone name or similar information.  (OS dependent) |
 #
 # **Weekday:**
 #
 # | Format | Meaning |
 # | ------ | ------- |
-# | A | The full weekday name ("Sunday") |
-# | a | The abbreviated name ("Sun") |
-# | u | Day of the week (Monday is 1, 1..7) |
-# | w | Day of the week (Sunday is 0, 0..6) |
+# | A | The full weekday name (`"Sunday"`) |
+# | a | The abbreviated name (`"Sun"`) |
+# | u | Day of the week (Monday is `1`, `1..7`) |
+# | w | Day of the week (Sunday is `0`, `0..6`) |
 #
 # **ISO 8601 week-based year and week number:**
 #
@@ -397,8 +397,8 @@
 # | Format | Meaning |
 # | ------ | ------- |
 # | G | The week-based year |
-# | g | The last 2 digits of the week-based year (00..99) |
-# | V | Week number of the week-based year (01..53) |
+# | g | The last 2 digits of the week-based year (`00..99`) |
+# | V | Week number of the week-based year (`01..53`) |
 #
 # **Week number:**
 #
@@ -407,8 +407,8 @@
 #
 # | Format | Meaning |
 # | ------ | ------- |
-# | U | Week number of the year. The week starts with Sunday. (00..53) |
-# | W | Week number of the year. The week starts with Monday. (00..53) |
+# | U | Week number of the year. The week starts with Sunday. (`00..53`) |
+# | W | Week number of the year. The week starts with Monday. (`00..53`) |
 #
 # **Seconds since the Epoch:**
 #
@@ -419,23 +419,23 @@
 #
 # | Format | Meaning |
 # | ------ | ------- |
-# | n | Newline character (\n) |
-# | t | Tab character (\t) |
-# | % | Literal "%" character |
+# | n | Newline character (`\n`) |
+# | t | Tab character (`\t`) |
+# | % | Literal `%` character |
 #
 # **Combination:**
 #
 # | Format | Meaning |
 # | ------ | ------- |
-# | c | date and time (%a %b %e %T %Y) |
-# | D | Date (%m/%d/%y) |
-# | F | The ISO 8601 date format (%Y-%m-%d) |
-# | v | VMS date (%e-%^b-%4Y) |
-# | x | Same as %D |
-# | X | Same as %T |
-# | r | 12-hour time (%I:%M:%S %p) |
-# | R | 24-hour time (%H:%M) |
-# | T | 24-hour time (%H:%M:%S) |
+# | c | date and time (`%a %b %e %T %Y`) |
+# | D | Date (`%m/%d/%y`) |
+# | F | The ISO 8601 date format (`%Y-%m-%d`) |
+# | v | VMS date (`%e-%^b-%4Y`) |
+# | x | Same as `%D` |
+# | X | Same as `%T` |
+# | r | 12-hour time (`%I:%M:%S %p`) |
+# | R | 24-hour time (`%H:%M`) |
+# | T | 24-hour time (`%H:%M:%S`) |
 #
 # The default array contains the following patterns:
 #
@@ -489,7 +489,7 @@
 # The mapping from data type to format is referred to as the *format map*. This map
 # allows different formatting depending on type.
 #
-# @example Positive Integers in Hexadecimal prefixed with '0x', negative in Decimal
+# @example Positive Integers in Hexadecimal prefixed with `'0x'`, negative in Decimal
 #
 # ```puppet
 # $format_map = {
@@ -578,13 +578,13 @@
 #
 # | Format  | Integer Formats
 # | ------  | ---------------
-# | d       | Decimal, negative values produces leading '-'.
-# | x X     | Hexadecimal in lower or upper case. Uses ..f/..F for negative values unless + is also used. A `#` adds prefix 0x/0X.
-# | o       | Octal. Uses ..0 for negative values unless `+` is also used. A `#` adds prefix 0.
-# | b B     | Binary with prefix 'b' or 'B'. Uses ..1/..1 for negative values unless `+` is also used.
-# | c       | Numeric value representing a Unicode value, result is a one unicode character string, quoted if alternative flag # is used
-# | s       | Same as d, or d in quotes if alternative flag # is used.
-# | p       | Same as d.
+# | d       | Decimal, negative values produces leading `-`.
+# | x X     | Hexadecimal in lower or upper case. Uses `..f/..F` for negative values unless `+` is also used. A `#` adds prefix `0x/0X`.
+# | o       | Octal. Uses `..0` for negative values unless `+` is also used. A `#` adds prefix `0`.
+# | b B     | Binary with prefix `b` or `B`. Uses `..1/..1` for negative values unless `+` is also used.
+# | c       | Numeric value representing a Unicode value, result is a one unicode character string, quoted if alternative flag `#` is used
+# | s       | Same as `d`, or `d` in quotes if alternative flag `#` is used.
+# | p       | Same as `d`.
 # | eEfgGaA | Converts integer to float and formats using the floating point rules.
 #
 # Defaults to `d`.
@@ -594,11 +594,11 @@
 # | Format  | Float formats
 # | ------  | -------------
 # | f       | Floating point in non exponential notation.
-# | e E     | Exponential notation with 'e' or 'E'.
-# | g G     | Conditional exponential with 'e' or 'E' if exponent < -4 or >= the precision.
-# | a A     | Hexadecimal exponential form, using 'x'/'X' as prefix and 'p'/'P' before exponent.
-# | s       | Converted to string using format p, then applying string formatting rule, alternate form # quotes result.
-# | p       | Same as f format with minimum significant number of fractional digits, prec has no effect.
+# | e E     | Exponential notation with `e` or `E`.
+# | g G     | Conditional exponential with `e` or `E` if exponent `< -4` or `>=` the precision.
+# | a A     | Hexadecimal exponential form, using `x`/`X` as prefix and `p`/`P` before exponent.
+# | s       | Converted to string using format `p`, then applying string formatting rule, alternate form `#`` quotes result.
+# | p       | Same as `f` format with minimum significant number of fractional digits, prec has no effect.
 # | dxXobBc | Converts float to integer and formats using the integer rules.
 #
 # Defaults to `p`.
@@ -621,12 +621,12 @@
 #
 # | Format    | Boolean Formats
 # | ----      | -------------------
-# | t T       | String 'true'/'false' or 'True'/'False', first char if alternate form is used (i.e. 't'/'f' or 'T'/'F').
-# | y Y       | String 'yes'/'no', 'Yes'/'No', 'y'/'n' or 'Y'/'N' if alternative flag `#` is used.
-# | dxXobB    | Numeric value 0/1 in accordance with the given format which must be valid integer format.
-# | eEfgGaA   | Numeric value 0.0/1.0 in accordance with the given float format and flags.
-# | s         | String 'true' / 'false'.
-# | p         | String 'true' / 'false'.
+# | t T       | String `'true'/'false'` or `'True'/'False'`, first char if alternate form is used (i.e. `'t'/'f'` or `'T'/'F'`).
+# | y Y       | String `'yes'/'no'`, `'Yes'/'No'`, `'y'/'n'` or `'Y'/'N'` if alternative flag `#` is used.
+# | dxXobB    | Numeric value `0/1` in accordance with the given format which must be valid integer format.
+# | eEfgGaA   | Numeric value `0.0/1.0` in accordance with the given float format and flags.
+# | s         | String `'true'` / `'false'`.
+# | p         | String `'true'` / `'false'`.
 #
 # **Regexp to String**
 #
@@ -640,33 +640,33 @@
 # | Format    | Undef formats
 # | ------    | -------------
 # | s         | Empty string, or quoted empty string if alternative flag `#` is used.
-# | p         | String 'undef', or quoted '"undef"' if alternative flag `#` is used.
-# | n         | String 'nil', or 'null' if alternative flag `#` is used.
-# | dxXobB    | String 'NaN'.
-# | eEfgGaA   | String 'NaN'.
-# | v         | String 'n/a'.
-# | V         | String 'N/A'.
-# | u         | String 'undef', or 'undefined' if alternative `#` flag is used.
+# | p         | String `'undef'`, or quoted `'"undef"'` if alternative flag `#` is used.
+# | n         | String `'nil'`, or `'null'` if alternative flag `#` is used.
+# | dxXobB    | String `'NaN'`.
+# | eEfgGaA   | String `'NaN'`.
+# | v         | String `'n/a'`.
+# | V         | String `'N/A'`.
+# | u         | String `'undef'`, or `'undefined'` if alternative `#` flag is used.
 #
 # **Default value to String**
 #
 # | Format    | Default formats
 # | ------    | ---------------
-# | d D       | String 'default' or 'Default', alternative form `#` causes value to be quoted.
-# | s         | Same as d.
-# | p         | Same as d.
+# | d D       | String `'default'` or `'Default'`, alternative form `#` causes value to be quoted.
+# | s         | Same as `d`.
+# | p         | Same as `d`.
 #
 # **Binary value to String**
 #
 # | Format    | Default formats
 # | ------    | ---------------
 # | s         | binary as unquoted UTF-8 characters (errors if byte sequence is invalid UTF-8). Alternate form escapes non ascii bytes.
-# | p         | 'Binary("<base64strict>")'
-# | b         | '<base64>' - base64 string with newlines inserted
-# | B         | '<base64strict>' - base64 strict string (without newlines inserted)
-# | u         | '<base64urlsafe>' - base64 urlsafe string
-# | t         | 'Binary' - outputs the name of the type only
-# | T         | 'BINARY' - output the name of the type in all caps only
+# | p         | `'Binary("<base64strict>")'`
+# | b         | `'<base64>'` - base64 string with newlines inserted
+# | B         | `'<base64strict>'` - base64 strict string (without newlines inserted)
+# | u         | `'<base64urlsafe>'` - base64 urlsafe string
+# | t         | `'Binary'` - outputs the name of the type only
+# | T         | `'BINARY'` - output the name of the type in all caps only
 #
 # * The alternate form flag `#` will quote the binary or base64 text output.
 # * The format `%#s` allows invalid UTF-8 characters and outputs all non ascii bytes
@@ -678,8 +678,8 @@
 # | Format    | Array/Tuple Formats
 # | ------    | -------------
 # | a         | Formats with `[ ]` delimiters and `,`, alternate form `#` indents nested arrays/hashes.
-# | s         | Same as a.
-# | p         | Same as a.
+# | s         | Same as `a`.
+# | p         | Same as `a`.
 #
 # See "Flags" `<[({\|` for formatting of delimiters, and "Additional parameters for containers; Array and Hash" for
 # more information about options.
@@ -695,7 +695,7 @@
 # | h         | Formats with `{ }` delimiters, `,` element separator and ` => ` inner element separator unless overridden by flags.
 # | s         | Same as h.
 # | p         | Same as h.
-# | a         | Converts the hash to an array of [k,v] tuples and formats it using array rule(s).
+# | a         | Converts the hash to an array of `[k,v]` tuples and formats it using array rule(s).
 #
 # See "Flags" `<[({\|` for formatting of delimiters, and "Additional parameters for containers; Array and Hash" for
 # more information about options.
@@ -714,18 +714,18 @@
 # | Flag     | Effect
 # | ------   | ------
 # | (space)  | A space instead of `+` for numeric output (`-` is shown), for containers skips delimiters.
-# | #        | Alternate format; prefix 0x/0x, 0 (octal) and 0b/0B for binary, Floats force decimal '.'. For g/G keep trailing 0.
-# | +        | Show sign +/- depending on value's sign, changes x, X, o, b, B format to not use 2's complement form.
+# | #        | Alternate format; prefix `0x/0x`, `0` (octal) and `0b/0B` for binary, Floats force decimal '.'. For g/G keep trailing `0`.
+# | +        | Show sign `+/-` depending on value's sign, changes `x`, `X`, `o`, `b`, `B` format to not use 2's complement form.
 # | -        | Left justify the value in the given width.
-# | 0        | Pad with 0 instead of space for widths larger than value.
-# | <[({\|   | Defines an enclosing pair <> [] () {} or \| \| when used with a container type.
+# | 0        | Pad with `0` instead of space for widths larger than value.
+# | <[({\|   | Defines an enclosing pair `<> [] () {} or \| \|` when used with a container type.
 #
 # ### Conversion to Boolean
 #
 # Accepts a single value as argument:
 #
-# * Float 0.0 is `false`, all other float values are `true`
-# * Integer 0 is `false`, all other integer values are `true`
+# * Float `0.0` is `false`, all other float values are `true`
+# * Integer `0` is `false`, all other integer values are `true`
 # * Strings
 #   * `true` if 'true', 'yes', 'y' (case independent compare)
 #   * `false` if 'false', 'no', 'n' (case independent compare)
@@ -840,7 +840,7 @@
 # function SemVer.new(SemVerHash $hash_args)
 # ```
 #
-# @example SemVer and SemVerRange usage
+# @example `SemVer` and `SemVerRange` usage
 #
 # ```puppet
 # # As a type, SemVer can describe disjunct ranges which versions can be
@@ -856,7 +856,7 @@
 # notice(SemVer('3.4.5') =~ $t) # true
 # ```
 #
-# ### Creating a SemVerRange
+# ### Creating a `SemVerRange`
 #
 # A `SemVerRange` object represents a range of `SemVer`. It can be created from
 # a `String`, or from two `SemVer` instances, where either end can be given as