Merge pull request #20433 from nsoranzo/release_25.0_deprecate_enable_tool_document_cache

[25.0] Deprecate ``enable_tool_document_cache``

Author: ahmedhamidawan

doc/source/admin/galaxy_options.rst

@@ -1222,12 +1222,13 @@
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 :Description:
-    Whether to enable the tool document cache. This cache stores
-    expanded XML strings. Enabling the tool cache results in slightly
-    faster startup times. The tool cache is backed by a SQLite
-    database, which cannot be stored on certain network disks. The
-    cache location is configurable with the ``tool_cache_data_dir``
-    tag in tool config files.
+    This option is deprecated, and the tool document cache will be
+    removed in the next release. Whether to enable the tool document
+    cache. This cache stores expanded XML strings. Enabling the tool
+    cache results in slightly faster startup times. The tool cache is
+    backed by a SQLite database, which cannot be stored on certain
+    network disks. The cache location is configurable with the
+    ``tool_cache_data_dir`` tag in tool config files.
 :Default: ``false``
 :Type: bool
 

lib/galaxy/config/sample/galaxy.yml.sample

@@ -935,12 +935,13 @@ galaxy:
   # generated commands run in sh.
   #default_job_shell: /bin/bash
 
-  # Whether to enable the tool document cache. This cache stores
-  # expanded XML strings. Enabling the tool cache results in slightly
-  # faster startup times. The tool cache is backed by a SQLite database,
-  # which cannot be stored on certain network disks. The cache location
-  # is configurable with the ``tool_cache_data_dir`` tag in tool config
-  # files.
+  # This option is deprecated, and the tool document cache will be
+  # removed in the next release. Whether to enable the tool document
+  # cache. This cache stores expanded XML strings. Enabling the tool
+  # cache results in slightly faster startup times. The tool cache is
+  # backed by a SQLite database, which cannot be stored on certain
+  # network disks. The cache location is configurable with the
+  # ``tool_cache_data_dir`` tag in tool config files.
   #enable_tool_document_cache: false
 
   # Directory in which the toolbox search index is stored. The value of

lib/galaxy/config/schemas/config_schema.yml

@@ -887,6 +887,8 @@ mapping:
         default: false
         required: false
         desc: |
+          This option is deprecated, and the tool document cache will be removed
+          in the next release.
           Whether to enable the tool document cache. This cache stores
           expanded XML strings. Enabling the tool cache results in slightly faster startup
           times. The tool cache is backed by a SQLite database, which cannot