Fix inventory cache prefix typos (#74523)

* Fix section for inventory cache prefix

* Redirect general config inventory cache options to inventory plugin documentation

* Update the template to fix the docs-build error

* removes 'default' entries for config settings with default: ''

* single backticks => italics, double backticks => code

* use 'Default: ~' to match other entries that have no default setting

Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>

docs/templates/config.rst.j2

@@ -112,7 +112,7 @@ you can use the command line utility mentioned above (`ansible-config`) to brows
 :Type: {{config['type']}}
 {%     endif %}
 {%     if 'default' in config %}
-:Default: {{config['default']}}
+:Default: ``{{config['default']}}``
 {%     endif %}
 {%     if config.get('choices', False) %}
 :Choices:

lib/ansible/config/base.yml

@@ -482,7 +482,7 @@ DEFAULT_BECOME_EXE:
   - {key: become_exe, section: privilege_escalation}
 DEFAULT_BECOME_FLAGS:
   name: Set 'become' executable options
-  default: ''
+  default: ~
   description: Flags to pass to the privilege escalation executable.
   env: [{name: ANSIBLE_BECOME_FLAGS}]
   ini:
@@ -881,7 +881,7 @@ DEFAULT_MANAGED_STR:
   yaml: {key: defaults.ansible_managed}
 DEFAULT_MODULE_ARGS:
   name: Adhoc default arguments
-  default: ''
+  default: ~
   description:
     - This sets the default arguments to pass to the ``ansible`` adhoc binary if no ``-a`` is specified.
   env: [{name: ANSIBLE_MODULE_ARGS}]
@@ -1558,33 +1558,53 @@ INVENTORY_ANY_UNPARSED_IS_FAILED:
 INVENTORY_CACHE_ENABLED:
   name: Inventory caching enabled
   default: False
-  description: Toggle to turn on inventory caching
+  description:
+    - Toggle to turn on inventory caching.
+    - This setting has been moved to the individual inventory plugins as a plugin option :ref:`inventory_plugins`.
+    - The existing configuration settings are still accepted with the inventory plugin adding additional options from inventory configuration.
+    - This message will be removed in 2.16.
   env: [{name: ANSIBLE_INVENTORY_CACHE}]
   ini:
   - {key: cache, section: inventory}
   type: bool
 INVENTORY_CACHE_PLUGIN:
   name: Inventory cache plugin
-  description: The plugin for caching inventory. If INVENTORY_CACHE_PLUGIN is not provided CACHE_PLUGIN can be used instead.
+  description:
+    - The plugin for caching inventory.
+    - This setting has been moved to the individual inventory plugins as a plugin option :ref:`inventory_plugins`.
+    - The existing configuration settings are still accepted with the inventory plugin adding additional options from inventory and fact cache configuration.
+    - This message will be removed in 2.16.
   env: [{name: ANSIBLE_INVENTORY_CACHE_PLUGIN}]
   ini:
   - {key: cache_plugin, section: inventory}
 INVENTORY_CACHE_PLUGIN_CONNECTION:
   name: Inventory cache plugin URI to override the defaults section
-  description: The inventory cache connection. If INVENTORY_CACHE_PLUGIN_CONNECTION is not provided CACHE_PLUGIN_CONNECTION can be used instead.
+  description:
+    - The inventory cache connection.
+    - This setting has been moved to the individual inventory plugins as a plugin option :ref:`inventory_plugins`.
+    - The existing configuration settings are still accepted with the inventory plugin adding additional options from inventory and fact cache configuration.
+    - This message will be removed in 2.16.
   env: [{name: ANSIBLE_INVENTORY_CACHE_CONNECTION}]
   ini:
   - {key: cache_connection, section: inventory}
 INVENTORY_CACHE_PLUGIN_PREFIX:
   name: Inventory cache plugin table prefix
-  description: The table prefix for the cache plugin. If INVENTORY_CACHE_PLUGIN_PREFIX is not provided CACHE_PLUGIN_PREFIX can be used instead.
+  description:
+    - The table prefix for the cache plugin.
+    - This setting has been moved to the individual inventory plugins as a plugin option :ref:`inventory_plugins`.
+    - The existing configuration settings are still accepted with the inventory plugin adding additional options from inventory and fact cache configuration.
+    - This message will be removed in 2.16.
   env: [{name: ANSIBLE_INVENTORY_CACHE_PLUGIN_PREFIX}]
-  default: ansible_facts
+  default: ansible_inventory_
   ini:
   - {key: cache_prefix, section: inventory}
 INVENTORY_CACHE_TIMEOUT:
   name: Inventory cache plugin expiration timeout
-  description: Expiration timeout for the inventory cache plugin data. If INVENTORY_CACHE_TIMEOUT is not provided CACHE_TIMEOUT can be used instead.
+  description:
+    - Expiration timeout for the inventory cache plugin data.
+    - This setting has been moved to the individual inventory plugins as a plugin option :ref:`inventory_plugins`.
+    - The existing configuration settings are still accepted with the inventory plugin adding additional options from inventory and fact cache configuration.
+    - This message will be removed in 2.16.
   default: 3600
   env: [{name: ANSIBLE_INVENTORY_CACHE_TIMEOUT}]
   ini:

lib/ansible/plugins/doc_fragments/inventory_cache.py

@@ -69,6 +69,11 @@ options:
     ini:
       - section: default
         key: fact_caching_prefix
+        deprecated:
+          alternatives: Use the 'defaults' section instead
+          version: '2.16'
+      - section: defaults
+        key: fact_caching_prefix
       - section: inventory
         key: cache_prefix
 '''