(MODULES-10763) loglevel won't affect reports

The README suggests that setting a sufficiently high `loglevel` metaparameter
value will squelch the `Exec[apt_update]` resource's corrective changes from
agent reports. This is not true. Correct and clarify this statement to limit
its scope to log output, and link to MODULES-10763 for context on the exec
resource's false-positive reporting of corrective changes as a known issue.

diff --git a/README.md b/README.md
index 74e675803d114b7cc58799394f857a1a9c155c54..df9ec5091d09571c6a68132283af4de4997f9ce7 100644 (file)
--- a/README.md
+++ b/README.md
@@ -96,7 +96,7 @@ class { 'apt':
   },
 }
 ```
-When `Exec['apt_update']` is triggered, it generates a `Notice` message. Because the default [logging level for agents](https://docs.puppet.com/puppet/latest/configuration.html#loglevel) is `notice`, this causes the repository update to appear in logs and agent reports. Some tools, such as [The Foreman](https://www.theforeman.org), report the update notice as a significant change. To eliminate these updates from reports, set the [loglevel](https://docs.puppet.com/puppet/latest/metaparameter.html#loglevel) metaparameter for `Exec['apt_update']` above the agent logging level:
+When `Exec['apt_update']` is triggered, it generates a `notice`-level message. Because the default [logging level for agents](https://puppet.com/docs/puppet/latest/configuration.html#loglevel) is `notice`, this causes the repository update to appear in agent logs. To silence these updates from the default log output, set the [loglevel](https://puppet.com/docs/puppet/latest/metaparameter.html#loglevel) metaparameter for `Exec['apt_update']` above the agent logging level:
 
 ```puppet
 class { 'apt':
@@ -107,6 +107,8 @@ class { 'apt':
 }
 ```
 
+> **NOTE:** Every `Exec['apt_update']` run will generate a corrective change, even if the apt caches are not updated. For example, setting an update frequency of `always` can result in every Puppet run resulting in a corrective change. This is a known issue. For details, see [MODULES-10763](https://tickets.puppetlabs.com/browse/MODULES-10763).
+
 <a id="pin-a-specific-release"></a>
 ### Pin a specific release