From: Brian Warner <warner@lothar.com>
Date: Tue, 9 Apr 2013 11:06:52 +0000 (+0100)
Subject: webapi.rst: small edits to the t=relink section
X-Git-Tag: allmydata-tahoe-1.10b1~21
X-Git-Url: https://git.rkrishnan.org/?a=commitdiff_plain;h=f9335892f2008198bd8210b98dd953665d8a5e08;p=tahoe-lafs%2Ftahoe-lafs.git

webapi.rst: small edits to the t=relink section
---

diff --git a/docs/frontends/webapi.rst b/docs/frontends/webapi.rst
index 0e43e4a7..433cd7a3 100644
--- a/docs/frontends/webapi.rst
+++ b/docs/frontends/webapi.rst
@@ -29,7 +29,7 @@ The Tahoe REST-ful Web API
     6.  `Attaching an Existing File Or Directory (by URI)`_
     7.  `Unlinking a Child`_
     8.  `Renaming a Child`_
-    9.  `Relinking a Child`_
+    9.  `Moving a Child`_
     10. `Other Utilities`_
     11. `Debugging and Testing Features`_
 
@@ -1287,19 +1287,20 @@ Renaming a Child
  for "False"; and the parameter is case-insensitive.
 
 
-Relinking a Child
------------------
+Moving a Child
+--------------
 
-``POST /uri/$DIRCAP/[SUBDIRS../]?t=rename&from_name=OLD&to_dir=$NEWDIRCAP/[NEWSUBDIRS../]&to_name=NEW``
+``POST /uri/$DIRCAP/[SUBDIRS../]?t=relink&from_name=OLD&to_dir=$NEWDIRCAP/[NEWSUBDIRS../]&to_name=NEW``
  ``[&replace=true|false|only-files]``    (Tahoe >= v1.10)
 
- This instructs the node to relink a child of the given source directory,
- into a different directory and/or to a different name. The source and
- destination directories must be writeable. If {{{to_dir}}} is not present,
- the child link is renamed within the same directory. If {{{to_name}}} is
- not present then it defaults to {{{from_name}}}. If the destination link
- (directory and name) is the same as the source link, the operation has no
- effect.
+ This instructs the node to move a child of the given source directory,
+ into a different directory and/or to a different name. The command is
+ named ``relink`` because it works by adding a new link from the new
+ location, then removing the old link. The source and destination
+ directories must be writeable. If {{{to_dir}}} is not present, the child
+ link is renamed within the same directory. If {{{to_name}}} is not present
+ then it defaults to {{{from_name}}}. If the destination link (directory
+ and name) is the same as the source link, the operation has no effect.
 
  Metadata from the source directory entry is preserved. Multiple levels of
  descent in the source and destination paths are supported.