From: Brian Warner <warner@lothar.com>
Date: Wed, 22 Oct 2008 00:53:31 +0000 (-0700)
Subject: webapi.txt: improve t=deep-size output docs
X-Git-Url: https://git.rkrishnan.org/pf/content/%22file:/%5B%5E?a=commitdiff_plain;h=1d89c846b9dd7674b6daae6d81d7c04b21a3ee81;p=tahoe-lafs%2Ftahoe-lafs.git

webapi.txt: improve t=deep-size output docs
---

diff --git a/docs/webapi.txt b/docs/webapi.txt
index de46302a..dfe24995 100644
--- a/docs/webapi.txt
+++ b/docs/webapi.txt
@@ -968,6 +968,11 @@ POST $DIRURL?t=start-deep-size    (must add &ophandle=XYZ)
   take expansion or encoding overhead into account. Later versions of the
   code may improve this estimate upwards.
 
+  The t=status output consists of two lines of text:
+
+   finished: yes
+   size: 1234
+
 POST $DIRURL?t=start-deep-stats    (must add &ophandle=XYZ)
 
   This operation performs a recursive walk of all files and directories