Difference between revisions of "Wipe cache.m"

From Spinach Documentation Wiki
Jump to: navigation, search
(Sync syntax/arguments/outputs with current Spinach source)
(Restore pre-bulk-edit wiki content)
Line 1: Line 1:
 
{{DISPLAYTITLE:wipe_cache.m}} __NOTOC__
 
{{DISPLAYTITLE:wipe_cache.m}} __NOTOC__
 
 
Forces a wipe of the Spinach cache folder.
 
Forces a wipe of the Spinach cache folder.
  
 
==Syntax==
 
==Syntax==
  
wipe_cache(spin_system)
+
    wipe_cache(spin_system)
  
 
==Arguments==
 
==Arguments==
  
spin_system - Spinach object with information (stored
+
    spin_system - Spinach object with information (stored
 
                   in spin_system.sys.scratch) about the cache
 
                   in spin_system.sys.scratch) about the cache
 
                   folder location; use bootstrap() to get the  
 
                   folder location; use bootstrap() to get the  
Line 16: Line 15:
 
==Outputs==
 
==Outputs==
  
an attempt is made to delete all all Spinach-specific
+
    an attempt is made to delete all Spinach-specific files in
    files in spin_system.sys.scratch; this would fail qui-
+
    spin_system.sys.scratch; this would fail quietly if file  
    etly if file system permissions are insufficient
+
    system permissions are insufficient
 
 
ilya.kuprov@weizmann.ac.il
 
  
 
==See also==
 
==See also==
 
 
[[Kernel_utilities#Housekeeping_functions|Housekeeping functions]]
 
[[Kernel_utilities#Housekeeping_functions|Housekeeping functions]]
  
  
 
''Version 2.11, authors: [[Ilya Kuprov]]''
 
''Version 2.11, authors: [[Ilya Kuprov]]''

Revision as of 15:50, 5 April 2026

Forces a wipe of the Spinach cache folder.

Syntax

   wipe_cache(spin_system)

Arguments

   spin_system - Spinach object with information (stored
                 in spin_system.sys.scratch) about the cache
                 folder location; use bootstrap() to get the 
                 default object

Outputs

   an attempt is made to delete all Spinach-specific files in
   spin_system.sys.scratch; this would fail quietly if file 
   system permissions are insufficient

See also

Housekeeping functions


Version 2.11, authors: Ilya Kuprov