From 0b2e2f430795ca114edd76631e22adaa3d40ff14 Mon Sep 17 00:00:00 2001
From: Nicola Soranzo <nicola.soranzo@earlham.ac.uk>
Date: Tue, 10 Jun 2025 19:57:43 +0100
Subject: [PATCH] Deprecate ``enable_tool_document_cache``

See https://github.com/galaxyproject/galaxy/issues/20432 .
---
 doc/source/admin/galaxy_options.rst         | 13 +++++++------
 lib/galaxy/config/sample/galaxy.yml.sample  | 13 +++++++------
 lib/galaxy/config/schemas/config_schema.yml |  2 ++
 3 files changed, 16 insertions(+), 12 deletions(-)

diff --git a/doc/source/admin/galaxy_options.rst b/doc/source/admin/galaxy_options.rst
index 89afa67da80..539375070e7 100644
--- a/doc/source/admin/galaxy_options.rst
+++ b/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
 
diff --git a/lib/galaxy/config/sample/galaxy.yml.sample b/lib/galaxy/config/sample/galaxy.yml.sample
index 53f4e5a91dc..27f517a2e4b 100644
--- a/lib/galaxy/config/sample/galaxy.yml.sample
+++ b/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
diff --git a/lib/galaxy/config/schemas/config_schema.yml b/lib/galaxy/config/schemas/config_schema.yml
index 173ca3ab233..e798a0a310d 100644
--- a/lib/galaxy/config/schemas/config_schema.yml
+++ b/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