From 4861d50c2fa6a7441519c75db4b25d364817bd4f Mon Sep 17 00:00:00 2001
From: david-sarah <david-sarah@jacaranda.org>
Date: Tue, 12 Jul 2011 17:27:22 -0700
Subject: [PATCH] docs: some changes of 'delete' or 'rm' to 'unlink'. refs
 #1104

---
 docs/frontends/CLI.rst           | 20 ++++++++++++--------
 docs/specifications/dirnodes.rst |  2 +-
 2 files changed, 13 insertions(+), 9 deletions(-)

diff --git a/docs/frontends/CLI.rst b/docs/frontends/CLI.rst
index 2f4cb1fc..7215a0bb 100644
--- a/docs/frontends/CLI.rst
+++ b/docs/frontends/CLI.rst
@@ -44,7 +44,7 @@ CLI Command Overview
 The "``tahoe``" tool provides access to three categories of commands.
 
 * node management: create a client/server node, start/stop/restart it
-* filesystem manipulation: list files, upload, download, delete, rename
+* filesystem manipulation: list files, upload, download, unlink, rename
 * debugging: unpack cap-strings, examine share files
 
 To get a list of all commands, just run "``tahoe``" with no additional
@@ -134,7 +134,7 @@ Filesystem Manipulation
 =======================
 
 These commands let you exmaine a Tahoe-LAFS filesystem, providing basic
-list/upload/download/delete/rename/mkdir functionality. They can be used as
+list/upload/download/unlink/rename/mkdir functionality. They can be used as
 primitives by other scripts. Most of these commands are fairly thin wrappers
 around web-API calls, which are described in `<webapi.rst>`_.
 
@@ -348,9 +348,9 @@ Command Examples
 
  This uses the python 'webbrowser' module to cause a local web browser to
  open to the web page for the given directory. This page offers interfaces to
- add, download, rename, and delete files in the directory. If no alias or
- path is given, this command opens the root directory of the default
- ``tahoe:`` alias.
+ add, download, rename, and unlink files and subdirectories in that directory.
+ If no alias or path is given, this command opens the root directory of the
+ default ``tahoe:`` alias.
 
 ``tahoe put file.txt``
 
@@ -431,11 +431,15 @@ Command Examples
  This copies a file from your ``tahoe:`` root to a different directory, set up
  earlier with "``tahoe add-alias fun DIRCAP``" or "``tahoe create-alias fun``".
 
-``tahoe rm uploaded.txt``
+``tahoe unlink uploaded.txt``
 
-``tahoe rm tahoe:uploaded.txt``
+``tahoe unlink tahoe:uploaded.txt``
 
- This deletes a file from your ``tahoe:`` root.
+ This unlinks a file from your ``tahoe:`` root (that is, causes there to no
+ longer be an entry ``uploaded.txt`` in the root directory that points to it).
+ Note that this does not delete the file from the grid.
+ For backward compatibility, ``tahoe rm`` is accepted as a synonym for
+ ``tahoe unlink``.
 
 ``tahoe mv uploaded.txt renamed.txt``
 
diff --git a/docs/specifications/dirnodes.rst b/docs/specifications/dirnodes.rst
index ec6bd235..e68b02f6 100644
--- a/docs/specifications/dirnodes.rst
+++ b/docs/specifications/dirnodes.rst
@@ -388,7 +388,7 @@ alive until the last lease has expired or been cancelled. Clients which know
 and care about specific dirnodes can ask to keep them alive for a while, by
 renewing a lease on them (with a typical period of one month). Clients are
 expected to assist in the deletion of dirnodes by canceling their leases as
-soon as they are done with them. This means that when a client deletes a
+soon as they are done with them. This means that when a client unlinks a
 directory, it should also cancel its lease on that directory. When the lease
 count on a given share goes to zero, the storage server can delete the
 related storage. Multiple clients may all have leases on the same dirnode:
-- 
2.45.2