[Rt-commit] r6339 - in rt/branches/3.7-EXPERIMENTAL: .

[schwern at bestpractical.com]

Author: schwern
Date: Tue Oct 31 20:55:35 2006
New Revision: 6339

Modified:
   rt/branches/3.7-EXPERIMENTAL/   (props changed)
   rt/branches/3.7-EXPERIMENTAL/lib/RT/Shredder.pm

Log:
 r24986 at windhund:  schwern | 2006-10-31 17:12:04 -0500
 Explain RT's idea of "delete" vs Shredder's "Wipeout".  Use the latter at
 all places in the docs to avoid ambiguity.


Modified: rt/branches/3.7-EXPERIMENTAL/lib/RT/Shredder.pm
==============================================================================
--- rt/branches/3.7-EXPERIMENTAL/lib/RT/Shredder.pm	(original)
+++ rt/branches/3.7-EXPERIMENTAL/lib/RT/Shredder.pm	Tue Oct 31 20:55:35 2006
@@ -6,7 +6,7 @@
 
 =head1 NAME
 
-RT::Shredder - Permanently delete data from RT
+RT::Shredder - Permanently wipeout data from RT
 
 
 =head1 SYNOPSIS
@@ -32,10 +32,18 @@
 
 =head1 DESCRIPTION
 
-RT::Shredder is extention to RT which allows you to permanently delete
-data from the RT database.  Shredder supports the deletion of almost
+RT::Shredder is extention to RT which allows you to permanently wipeout
+data from the RT database.  Shredder supports the wiping of almost
 all RT objects (Tickets, Transactions, Attachments, Users...).
 
+
+=head2 "Delete" vs "Wipeout"
+
+RT uses the term "delete" to mean "deactivate".  To avoid confusion,
+RT::Shredder uses the term "Wipeout" to mean "permanently erase" (or
+what most people would think of as "delete").
+
+
 =head2 Why do you want this?
 
 Normally in RT, "deleting" an item simply deactivates it and makes it
@@ -55,15 +63,17 @@
 
 =head2 Command line tools (CLI)
 
-L<rt-shredder> is a program which allows you to delete objects from
+L<rt-shredder> is a program which allows you to wipe objects from
 command line or with system tasks scheduler (cron, for example).
 
+
 =head2 Web based interface (WebUI)
 
 Shredder's WebUI integrates into RT's WebUI.  You can find it in the
 Configuration->Tools->Shredder tab.  The interface is similar to the
 CLI and gives you the same functionality.
 
+
 =head2 API
 
 L<RT::Shredder> is an extension to RT which adds shredder methods to
@@ -517,7 +527,7 @@
 
 =head2 DATA STORAGE AND BACKUPS
 
-Shredder allow you to store data you delete in files as scripts with SQL
+Shredder allow you to store data you wiped in files as scripts with SQL
 commands.
 
 =head3 GetFileName( FileName => '<ISO DATETIME>-XXXX.sql', FromStorage => 1 )