From 532918800e5d7258595d1e4571f43f439643f1f1 Mon Sep 17 00:00:00 2001
From: Tim Otten <totten@civicrm.org>
Date: Thu, 13 Jul 2017 11:52:08 -0700
Subject: [PATCH] debugging.md - Remove misleading link
The doc mentions the page "Administer => System Settings => Cleanup Caches and Update Paths" as a way to clear caches. This is half-true: it does clear `templates_c` and the `civicrm_cache` table, but there are other things that it doesn't touch. (Compare `CRM_Admin_form_Setting_UpdateConfigBackend::postProcess` with the `CRM_Core_Invoke::rebuildMenuAndCaches`.)
IMHO, `UpdateConfigBackend::postProcess` should be patched to just do a general system flush (`civicrm_api3('System', 'flush', array())`) -- but (for now) the page is misleading and we shouldn't direct people there.
---
docs/tools/debugging.md | 9 +++++----
1 file changed, 5 insertions(+), 4 deletions(-)
diff --git a/docs/tools/debugging.md b/docs/tools/debugging.md
index 43d4fe63..7c940f31 100644
--- a/docs/tools/debugging.md
+++ b/docs/tools/debugging.md
@@ -196,10 +196,11 @@ Then, be sure to add the parameter `angularDebug=1` to the URL.
Clearing the cache is not a debugging technique, specifically. But sometimes it helps, and so is mentioned here for the sake of completeness.
-Using a web browser, either:
+Using a web browser:
- Navigate directly to `civicrm/clearcache`
-- Navigate to "Administer => System Settings => Cleanup Caches"
+
+<!-- FIXME: This page is misleading: Navigate to "Administer => System Settings => Cleanup Caches" -->
Using the command line, you can clear all caches with one of these commands:
@@ -209,8 +210,8 @@ Using the command line, you can clear all caches with one of these commands:
Alternatively, you can call the following methods in PHP code:
- `civicrm_api3('System', 'flush', array());` clears many different caches
-- `CRM_Core_Config::clearDBCache();` clears the database cache
-- `CRM_Core_Config::cleanup();` clears the file cache
+- `CRM_Core_Config::clearDBCache();` clears *only* the database cache
+- `CRM_Core_Config::cleanup();` clears *only* the file cache
--
GitLab