chef 16.0.257 → 16.0.275

data/lib/chef/resource/dnf_package.rb

@@ -40,7 +40,7 @@ class Chef
         which("dnf")
       end
 
-      description "Use the dnf_package resource to install, upgrade, and remove packages with DNF for Fedora and RHEL 8+. The dnf_package resource is able to resolve provides data for packages much like DNF can do when it is run from the command line. This allows a variety of options for installing packages, like minimum versions, virtual provides and library names."
+      description "Use the **dnf_package** resource to install, upgrade, and remove packages with DNF for Fedora and RHEL 8+. The dnf_package resource is able to resolve provides data for packages much like DNF can do when it is run from the command line. This allows a variety of options for installing packages, like minimum versions, virtual provides and library names."
       introduced "12.18"
 
       allowed_actions :install, :upgrade, :remove, :purge, :reconfig, :lock, :unlock, :flush_cache

data/lib/chef/resource/dpkg_package.rb

@@ -25,7 +25,7 @@ class Chef
 
       provides :dpkg_package
 
-      description "Use the dpkg_package resource to manage packages for the dpkg platform. When a package is installed from a local file, it must be added to the node using the remote_file or cookbook_file resources."
+      description "Use the **dpkg_package** resource to manage packages for the dpkg platform. When a package is installed from a local file, it must be added to the node using the **remote_file** or **cookbook_file** resources."
 
       property :source, [ String, Array, nil ],
         description: "The path to a package in the local file system."

data/lib/chef/resource/execute.rb

@@ -27,7 +27,7 @@ class Chef
 
       provides :execute, target_mode: true
 
-      description "Use the execute resource to execute a single command. Commands that"\
+      description "Use the **execute** resource to execute a single command. Commands that"\
                   " are executed with this resource are (by their nature) not idempotent,"\
                   " as they are typically unique to the environment in which they are run."\
                   " Use not_if and only_if to guard this resource for idempotence."
@@ -100,7 +100,7 @@ class Chef
         default: lazy { password ? true : false }, default_description: "True if the password property is set. False otherwise."
 
       property :elevated, [ TrueClass, FalseClass ], default: false,
-        description: "Determines whether the script will run with elevated permissions to circumvent User Access Control (UAC) interactively blocking the process.\nThis will cause the process to be run under a batch login instead of an interactive login. The user running #{Chef::Dist::CLIENT} needs the “Replace a process level token” and “Adjust Memory Quotas for a process” permissions. The user that is running the command needs the “Log on as a batch job” permission.\nBecause this requires a login, the user and password properties are required.",
+        description: "Determines whether the script will run with elevated permissions to circumvent User Access Control (UAC) interactively blocking the process.\nThis will cause the process to be run under a batch login instead of an interactive login. The user running #{Chef::Dist::CLIENT} needs the 'Replace a process level token' and 'Adjust Memory Quotas for a process' permissions. The user that is running the command needs the 'Log on as a batch job' permission.\nBecause this requires a login, the user and password properties are required.",
         introduced: "13.3"
 
       alias :env :environment

data/lib/chef/resource/file.rb

@@ -32,7 +32,7 @@ class Chef
 
       provides :file
 
-      description "Use the file resource to manage files directly on a node."
+      description "Use the **file** resource to manage files directly on a node."
 
       if ChefUtils.windows?
         # Use Windows rights instead of standard *nix permissions
@@ -59,10 +59,11 @@ class Chef
                description: "The full path to the file, including the file name and its extension. For example: /files/file.txt. Default value: the name of the resource block. Microsoft Windows: A path that begins with a forward slash (/) will point to the root of the current working directory of the #{Chef::Dist::CLIENT} process. This path can vary from system to system. Therefore, using a path that begins with a forward slash (/) is not recommended."
 
       property :atomic_update, [ TrueClass, FalseClass ], desired_state: false, default: lazy { docker? && special_docker_files?(path) ? false : Chef::Config[:file_atomic_update] },
-               description: "Perform atomic file updates on a per-resource basis. Set to true for atomic file updates. Set to false for non-atomic file updates. This setting overrides file_atomic_update, which is a global setting found in the client.rb file."
+               default_description: "False if modifying /etc/hosts, /etc/hostname, or /etc/resolv.conf within Docker containers. Otherwise default to the client.rb 'file_atomic_update' config value.",
+               description: "Perform atomic file updates on a per-resource basis. Set to true for atomic file updates. Set to false for non-atomic file updates. This setting overrides `file_atomic_update`, which is a global setting found in the `client.rb` file."
 
       property :backup, [ Integer, FalseClass ], desired_state: false, default: 5,
-               description: "The number of backups to be kept in /var/chef/backup (for UNIX- and Linux-based platforms) or C:/chef/backup (for the Microsoft Windows platform). Set to false to prevent backups from being kept."
+               description: "The number of backups to be kept in `/var/chef/backup` (for UNIX- and Linux-based platforms) or `C:/chef/backup` (for the Microsoft Windows platform). Set to `false` to prevent backups from being kept."
 
       property :checksum, [ /^[a-zA-Z0-9]{64}$/, nil ],
         description: "The SHA-256 checksum of the file. Use to ensure that a specific file is used. If the checksum does not match, the file is not used."
@@ -73,7 +74,7 @@ class Chef
       property :diff, [ String, nil ], desired_state: false, skip_docs: true
 
       property :force_unlink, [ TrueClass, FalseClass ], desired_state: false, default: false,
-               description: "How the #{Chef::Dist::CLIENT} handles certain situations when the target file turns out not to be a file. For example, when a target file is actually a symlink. Set to true for the #{Chef::Dist::CLIENT} delete the non-file target and replace it with the specified file. Set to false for the #{Chef::Dist::CLIENT} to raise an error."
+               description: "How #{Chef::Dist::PRODUCT} handles certain situations when the target file turns out not to be a file. For example, when a target file is actually a symlink. Set to true for #{Chef::Dist::PRODUCT} to delete the non-file target and replace it with the specified file. Set to false for #{Chef::Dist::PRODUCT} to raise an error."
 
       property :manage_symlink_source, [ TrueClass, FalseClass ], desired_state: false,
                description: "Change the behavior of the file resource if it is pointed at a symlink. When this value is set to true, #{Chef::Dist::PRODUCT} will manage the symlink's permissions or will replace the symlink with a normal file if the resource has content. When this value is set to false, #{Chef::Dist::PRODUCT} will follow the symlink and will manage the permissions and content of symlink's target file. The default behavior is true but emits a warning that the default value will be changed to false in a future version; setting this explicitly to true or false suppresses this warning."

data/lib/chef/resource/freebsd_package.rb

@@ -29,7 +29,7 @@ class Chef
       provides :freebsd_package
       provides :package, platform: "freebsd"
 
-      description "Use the freebsd_package resource to manage packages for the FreeBSD platform."
+      description "Use the **freebsd_package** resource to manage packages for the FreeBSD platform."
 
       # make sure we assign the appropriate underlying providers based on what
       # package managers exist on this FreeBSD system or the source of the package

data/lib/chef/resource/gem_package.rb

@@ -25,7 +25,7 @@ class Chef
       unified_mode true
       provides :gem_package
 
-      description "Use the gem_package resource to manage gem packages that are only included in recipes. When a package is installed from a local file, it must be added to the node using the remote_file or cookbook_file resources."
+      description "Use the **gem_package** resource to manage gem packages that are only included in recipes. When a package is installed from a local file, it must be added to the node using the remote_file or cookbook_file resources."
 
       property :package_name, String,
         description: "An optional property to set the package name if it differs from the resource block's name.",
@@ -46,21 +46,21 @@ class Chef
       # FIXME? the array form of installing paths most likely does not work?
       #
       property :source, [ String, Array ],
-        description: "Optional. The URL, or list of URLs, at which the gem package is located. This list is added to the source configured in Chef::Config[:rubygems_url] (see also include_default_source) to construct the complete list of rubygems sources. Users in an 'airgapped' environment should set Chef::Config[:rubygems_url] to their local RubyGems mirror."
+        description: "Optional. The URL, or list of URLs, at which the gem package is located. This list is added to the source configured in `Chef::Config[:rubygems_url]` (see also include_default_source) to construct the complete list of rubygems sources. Users in an 'airgapped' environment should set Chef::Config[:rubygems_url] to their local RubyGems mirror."
 
       property :clear_sources, [ TrueClass, FalseClass, nil ],
-        description: "Set to 'true' to download a gem from the path specified by the source property (and not from RubyGems).",
+        description: "Set to `true` to download a gem from the path specified by the `source` property (and not from RubyGems).",
         default: lazy { Chef::Config[:clear_gem_sources] }, desired_state: false
 
       property :gem_binary, String, desired_state: false,
-        description: "The path of a gem binary to use for the installation. By default, the same version of Ruby that is used by the #{Chef::Dist::CLIENT} will be installed."
+        description: "The path of a gem binary to use for the installation. By default, the same version of Ruby that is used by #{Chef::Dist::PRODUCT} will be installed."
 
       property :include_default_source, [ TrueClass, FalseClass, nil ],
-        description: "Set to 'false' to not include 'Chef::Config[:rubygems_url]'' in the sources.",
+        description: "Set to `false` to not include `Chef::Config[:rubygems_url]` in the sources.",
         default: nil, introduced: "13.0"
 
       property :options, [ String, Hash, Array, nil ],
-        description: "Options for the gem install, either a Hash or a String. When a hash is given, the options are passed to Gem::DependencyInstaller.new, and the gem will be installed via the gems API. When a String is given, the gem will be installed by shelling out to the gem command. Using a Hash of options with an explicit gem_binary will result in undefined behavior.",
+        description: "Options for the gem install, either a Hash or a String. When a hash is given, the options are passed to `Gem::DependencyInstaller.new`, and the gem will be installed via the gems API. When a String is given, the gem will be installed by shelling out to the gem command. Using a Hash of options with an explicit gem_binary will result in undefined behavior.",
         desired_state: false
     end
   end

data/lib/chef/resource/group.rb

@@ -23,7 +23,7 @@ class Chef
       unified_mode true
       state_attrs :members
 
-      description "Use the group resource to manage a local group."
+      description "Use the **group** resource to manage a local group."
 
       provides :group
 

data/lib/chef/resource/homebrew_cask.rb

@@ -27,7 +27,7 @@ class Chef
 
       provides(:homebrew_cask) { true }
 
-      description "Use the homebrew_cask resource to install binaries distributed via the Homebrew package manager."
+      description "Use the **homebrew_cask** resource to install binaries distributed via the Homebrew package manager."
       introduced "14.0"
 
       include Chef::Mixin::HomebrewUser

data/lib/chef/resource/homebrew_package.rb

@@ -29,7 +29,7 @@ class Chef
       provides :homebrew_package
       provides :package, os: "darwin"
 
-      description "Use the homebrew_package resource to manage packages for the macOS platform."
+      description "Use the **homebrew_package** resource to manage packages for the macOS platform."
       introduced "12.0"
 
       property :homebrew_user, [ String, Integer ],

data/lib/chef/resource/homebrew_tap.rb

@@ -27,7 +27,7 @@ class Chef
 
       provides(:homebrew_tap) { true }
 
-      description "Use the homebrew_tap resource to add additional formula repositories to the Homebrew package manager."
+      description "Use the **homebrew_tap** resource to add additional formula repositories to the Homebrew package manager."
       introduced "14.0"
 
       include Chef::Mixin::HomebrewUser

data/lib/chef/resource/hostname.rb

@@ -23,16 +23,16 @@ class Chef
 
       provides :hostname
 
-      description "Use the hostname resource to set the system's hostname, configure hostname and hosts config file, and re-run the Ohai hostname plugin so the hostname will be available in subsequent cookbooks."
+      description "Use the **hostname** resource to set the system's hostname, configure hostname and hosts config file, and re-run the Ohai hostname plugin so the hostname will be available in subsequent cookbooks."
       introduced "14.0"
       examples <<~DOC
-        Set the hostname using the IP address, as detected by Ohai
+        **Set the hostname using the IP address, as detected by Ohai**:
 
         ```ruby
         hostname 'example'
         ```
 
-        Manually specify the hostname and IP address
+        **Manually specify the hostname and IP address**:
 
         ```ruby
         hostname 'statically_configured_host' do
@@ -168,7 +168,7 @@ class Chef
               # older non-systemd RHEL/Fedora derived
               append_replacing_matching_lines("/etc/sysconfig/network", /^HOSTNAME\s*=/, "HOSTNAME=#{new_resource.hostname}")
             when ::File.exist?("/etc/HOSTNAME")
-              # SuSE/OpenSUSE uses /etc/HOSTNAME
+              # SuSE/openSUSE uses /etc/HOSTNAME
               declare_resource(:file, "/etc/HOSTNAME") do
                 content "#{new_resource.hostname}\n"
                 owner "root"

data/lib/chef/resource/http_request.rb

@@ -26,7 +26,7 @@ class Chef
 
       provides :http_request
 
-      description "Use the http_request resource to send an HTTP request (GET, PUT, POST, DELETE, HEAD, or OPTIONS) with an arbitrary message. This resource is often useful when custom callbacks are necessary."
+      description "Use the **http_request** resource to send an HTTP request (GET, PUT, POST, DELETE, HEAD, or OPTIONS) with an arbitrary message. This resource is often useful when custom callbacks are necessary."
 
       default_action :get
       allowed_actions :get, :patch, :put, :post, :delete, :head, :options

data/lib/chef/resource/ifconfig.rb

@@ -30,7 +30,7 @@ class Chef
 
       provides :ifconfig
 
-      description "Use the ifconfig resource to manage interfaces on Unix and Linux systems."
+      description "Use the **ifconfig** resource to manage interfaces on Unix and Linux systems."
 
       state_attrs :inet_addr, :mask
 
@@ -45,11 +45,11 @@ class Chef
         description: "The hardware address for the network interface."
 
       property :mask, String,
-        description: "The decimal representation of the network mask. For example: 255.255.255.0."
+        description: "The decimal representation of the network mask. For example: `255.255.255.0`."
 
       property :family, String, default: "inet",
-               introduced: "14.0",
-               description: "Networking family option for Debian-based systems; for example: inet or inet6."
+        introduced: "14.0",
+        description: "Networking family option for Debian-based systems; for example: `inet` or `inet6`."
 
       property :inet_addr, String,
         description: "The Internet host address for the network interface."
@@ -81,11 +81,11 @@ class Chef
 
       property :ethtool_opts, String,
         introduced: "13.4",
-        description: "Options to be passed to ethtool(8). For example: -A eth0 autoneg off rx off tx off."
+        description: "Options to be passed to ethtool(8). For example: `-A eth0 autoneg off rx off tx off`."
 
       property :bonding_opts, String,
         introduced: "13.4",
-        description: "Bonding options to pass via BONDING_OPTS on RHEL and CentOS. For example: mode=active-backup miimon=100."
+        description: "Bonding options to pass via `BONDING_OPTS` on RHEL and CentOS. For example: `mode=active-backup miimon=100`."
 
       property :master, String,
         introduced: "13.4",
@@ -93,7 +93,7 @@ class Chef
 
       property :slave, String,
         introduced: "13.4",
-        description: "When set to yes, this device is controlled by the channel bonding interface that is specified via the master property."
+        description: "When set to `yes`, this device is controlled by the channel bonding interface that is specified via the `master` property."
 
       property :vlan, String,
         introduced: "14.4",

data/lib/chef/resource/ips_package.rb

@@ -27,7 +27,7 @@ class Chef
       provides :ips_package
       provides :package, os: "solaris2"
 
-      description "Use the ips_package resource to manage packages (using Image Packaging System (IPS)) on the Solaris 11 platform."
+      description "Use the **ips_package** resource to manage packages (using Image Packaging System (IPS)) on the Solaris 11 platform."
 
       allowed_actions :install, :remove, :upgrade
 

data/lib/chef/resource/kernel_module.rb

@@ -15,7 +15,7 @@ class Chef
 
       provides :kernel_module
 
-      description "Use the kernel_module resource to manage kernel modules on Linux systems. This resource can load, unload, blacklist, disable, install, and uninstall modules."
+      description "Use the **kernel_module** resource to manage kernel modules on Linux systems. This resource can load, unload, blacklist, disable, install, and uninstall modules."
       introduced "14.3"
       examples <<~DOC
         Install and load a kernel module, and ensure it loads on reboot.

data/lib/chef/resource/ksh.rb

@@ -25,7 +25,7 @@ class Chef
 
       provides :ksh
 
-      description "Use the ksh resource to execute scripts using the Korn shell (ksh)"\
+      description "Use the **ksh** resource to execute scripts using the Korn shell (ksh)"\
                   " interpreter. This resource may also use any of the actions and properties"\
                   " that are available to the execute resource. Commands that are executed"\
                   " with this resource are (by their nature) not idempotent, as they are"\

data/lib/chef/resource/launchd.rb

@@ -24,7 +24,7 @@ class Chef
       unified_mode true
       provides :launchd
 
-      description "Use the launchd resource to manage system-wide services (daemons) and per-user services (agents) on the macOS platform."
+      description "Use the **launchd** resource to manage system-wide services (daemons) and per-user services (agents) on the macOS platform."
       introduced "12.8"
 
       default_action :create

data/lib/chef/resource/link.rb

@@ -28,14 +28,14 @@ class Chef
 
       provides :link
 
-      description "Use the link resource to create symbolic or hard links.\n\n"\
+      description "Use the **link** resource to create symbolic or hard links.\n\n"\
                   "A symbolic link—sometimes referred to as a soft link—is a directory entry"\
                   " that associates a file name with a string that contains an absolute or"\
-                  " relative path to a file on any file system. In other words, “a file that"\
-                  " contains a path that points to another file.” A symbolic link creates a new"\
+                  " relative path to a file on any file system. In other words, 'a file that"\
+                  " contains a path that points to another file.' A symbolic link creates a new"\
                   " file with a new inode that points to the inode location of the original file.\n\n"\
                   "A hard link is a directory entry that associates a file with another file in the"\
-                  " same file system. In other words, “multiple directory entries to the same file.”"\
+                  " same file system. In other words, 'multiple directory entries to the same file.'"\
                   " A hard link creates a new file that points to the same inode as the original file."
 
       state_attrs :owner # required since it's not a property below

data/lib/chef/resource/locale.rb

@@ -24,7 +24,7 @@ class Chef
       unified_mode true
       provides :locale
 
-      description "Use the locale resource to set the system's locale on Debian and Windows systems. Windows support was added in Chef Infra Client 16.0"
+      description "Use the **locale** resource to set the system's locale on Debian and Windows systems. Windows support was added in Chef Infra Client 16.0"
       introduced "14.5"
 
       examples <<~DOC

data/lib/chef/resource/log.rb

@@ -33,7 +33,7 @@ class Chef
 
       provides :log, target_mode: true
 
-      description "Use the log resource to create log entries. The log resource behaves"\
+      description "Use the **log** resource to create log entries. The log resource behaves"\
                   " like any other resource: built into the resource collection during the"\
                   " compile phase, and then run during the execution phase. (To create a log"\
                   " entry that is not built into the resource collection, use Chef::Log instead"\

data/lib/chef/resource/macos_userdefaults.rb

@@ -26,7 +26,7 @@ class Chef
       provides(:macos_userdefaults) { true }
       provides(:mac_os_x_userdefaults) { true }
 
-      description "Use the macos_userdefaults resource to manage the macOS user defaults system. The properties of this resource are passed to the defaults command, and the parameters follow the convention of that command. See the defaults(1) man page for details on how the tool works."
+      description "Use the **macos_userdefaults** resource to manage the macOS user defaults system. The properties of this resource are passed to the defaults command, and the parameters follow the convention of that command. See the defaults(1) man page for details on how the tool works."
       introduced "14.0"
 
       property :domain, String,

data/lib/chef/resource/macosx_service.rb

@@ -26,7 +26,7 @@ class Chef
       provides :macosx_service
       provides :service, os: "darwin"
 
-      description "Use the macosx_service resource to manage services on the macOS platform."
+      description "Use the **macosx_service** resource to manage services on the macOS platform."
 
       property :plist, String,
         description: "A plist to use in the case where the filename and label for the service do not match."

data/lib/chef/resource/macports_package.rb

@@ -24,7 +24,7 @@ class Chef
       unified_mode true
       provides :macports_package
 
-      description "Use the macports_package resource to manage packages for the macOS platform using the MacPorts package management system."
+      description "Use the **macports_package** resource to manage packages for the macOS platform using the MacPorts package management system."
 
       property :package_name, String,
         description: "An optional property to set the package name if it differs from the resource block's name.",

data/lib/chef/resource/mdadm.rb

@@ -26,7 +26,7 @@ class Chef
 
       provides :mdadm
 
-      description "Use the mdadm resource to manage RAID devices in a Linux environment using the mdadm utility. The mdadm resource"\
+      description "Use the **mdadm** resource to manage RAID devices in a Linux environment using the mdadm utility. The mdadm resource"\
                   " will create and assemble an array, but it will not create the config file that is used to persist the array upon"\
                   " reboot. If the config file is required, it must be done by specifying a template with the correct array layout,"\
                   " and then by using the mount provider to create a file systems table (fstab) entry."

data/lib/chef/resource/mount.rb

@@ -22,7 +22,7 @@ require_relative "../resource"
 class Chef
   class Resource
     class Mount < Chef::Resource
-      description "Use the mount resource to manage a mounted file system."
+      description "Use the **mount** resource to manage a mounted file system."
       unified_mode true
 
       provides :mount

data/lib/chef/resource/msu_package.rb

@@ -27,7 +27,7 @@ class Chef
 
       provides :msu_package
 
-      description "Use the msu_package resource to install Microsoft Update(MSU) packages on Microsoft Windows machines."
+      description "Use the **msu_package** resource to install Microsoft Update(MSU) packages on Microsoft Windows machines."
       introduced "12.17"
 
       allowed_actions :install, :remove

data/lib/chef/resource/ohai.rb

@@ -29,7 +29,7 @@ class Chef
 
       provides :ohai
 
-      description "Use the ohai resource to reload the Ohai configuration on a node. This allows recipes that change system attributes (like a recipe that adds a user) to refer to those attributes later on during the #{Chef::Dist::CLIENT} run."
+      description "Use the **ohai** resource to reload the Ohai configuration on a node. This allows recipes that change system attributes (like a recipe that adds a user) to refer to those attributes later on during the #{Chef::Dist::CLIENT} run."
 
       property :plugin, String,
         description: "The name of an Ohai plugin to be reloaded. If this property is not specified, #{Chef::Dist::PRODUCT} will reload all plugins."

data/lib/chef/resource/ohai_hint.rb

@@ -24,7 +24,7 @@ class Chef
 
       provides(:ohai_hint) { true }
 
-      description "Use the ohai_hint resource to aid in configuration detection by passing hint data to Ohai."
+      description "Use the **ohai_hint** resource to aid in configuration detection by passing hint data to Ohai."
       introduced "14.0"
 
       property :hint_name, String,

data/lib/chef/resource/openbsd_package.rb

@@ -29,7 +29,7 @@ class Chef
       provides :openbsd_package
       provides :package, os: "openbsd"
 
-      description "Use the openbsd_package resource to manage packages for the OpenBSD platform."
+      description "Use the **openbsd_package** resource to manage packages for the OpenBSD platform."
       introduced "12.1"
 
       property :package_name, String,

data/lib/chef/resource/openssl_dhparam.rb

@@ -25,7 +25,7 @@ class Chef
 
       provides(:openssl_dhparam) { true }
 
-      description "Use the openssl_dhparam resource to generate dhparam.pem files. If a valid dhparam.pem file is found at the specified location, no new file will be created. If a file is found at the specified location but it is not a valid dhparam file, it will be overwritten."
+      description "Use the **openssl_dhparam** resource to generate dhparam.pem files. If a valid dhparam.pem file is found at the specified location, no new file will be created. If a file is found at the specified location but it is not a valid dhparam file, it will be overwritten."
       introduced "14.0"
       examples <<~DOC
         Create a 1024bit dhparam file

data/lib/chef/resource/openssl_ec_private_key.rb

@@ -26,7 +26,7 @@ class Chef
 
       provides :openssl_ec_private_key
 
-      description "Use the openssl_ec_private_key resource to generate an elliptic curve (EC) private key file. If a valid EC key file can be opened at the specified location, no new file will be created. If the EC key file cannot be opened, either because it does not exist or because the password to the EC key file does not match the password in the recipe, then it will be overwritten."
+      description "Use the **openssl_ec_private_key** resource to generate an elliptic curve (EC) private key file. If a valid EC key file can be opened at the specified location, no new file will be created. If the EC key file cannot be opened, either because it does not exist or because the password to the EC key file does not match the password in the recipe, then it will be overwritten."
       introduced "14.4"
       examples <<~DOC
         Generate a new ec privatekey with prime256v1 key curve and default des3 cipher

data/lib/chef/resource/openssl_ec_public_key.rb

@@ -26,7 +26,7 @@ class Chef
 
       provides :openssl_ec_public_key
 
-      description "Use the openssl_ec_public_key resource to generate elliptic curve (EC) public key files from a given EC private key."
+      description "Use the **openssl_ec_public_key** resource to generate elliptic curve (EC) public key files from a given EC private key."
       introduced "14.4"
       examples <<~DOC
         Generate new ec public key from a private key on disk

data/lib/chef/resource/openssl_rsa_private_key.rb

@@ -26,7 +26,7 @@ class Chef
       provides(:openssl_rsa_private_key) { true }
       provides(:openssl_rsa_key) { true } # legacy cookbook resource name
 
-      description "Use the openssl_rsa_private_key resource to generate RSA private key files. If a valid RSA key file can be opened at the specified location, no new file will be created. If the RSA key file cannot be opened, either because it does not exist or because the password to the RSA key file does not match the password in the recipe, it will be overwritten."
+      description "Use the **openssl_rsa_private_key** resource to generate RSA private key files. If a valid RSA key file can be opened at the specified location, no new file will be created. If the RSA key file cannot be opened, either because it does not exist or because the password to the RSA key file does not match the password in the recipe, it will be overwritten."
       introduced "14.0"
       examples <<~DOC
         Generate new 2048bit key with the default des3 cipher