From: Richard Kettlewell <rjk@greenend.org.uk>
Date: Sat, 5 Jun 2010 13:40:53 +0000 (+0100)
Subject: Document that 'confirm' logs user in
X-Git-Tag: branchpoint-5.1~22^2~27
X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~mdw/git/disorder/commitdiff_plain/531a8ecd1dc7d4f827db9a2fc2090d9c4878ea17

Document that 'confirm' logs user in
---

diff --git a/doc/disorder_protocol.5.in b/doc/disorder_protocol.5.in
index b9ed984..f3cb615 100644
--- a/doc/disorder_protocol.5.in
+++ b/doc/disorder_protocol.5.in
@@ -75,7 +75,8 @@ If \fIREGEXP\fR is present only matching files and directories are returned.
 .B confirm \fICONFIRMATION
 Confirm user registration.
 \fICONFIRMATION\fR is as returned from \fBregister\fR below.
-This command can be used without logging in.
+This command logs the user in.
+The response contains the logged-in username.
 .TP
 .B cookie \fICOOKIE
 Log a user back in using a cookie created with \fBmake\-cookie\fR.
diff --git a/scripts/protocol b/scripts/protocol
index 46a1cbf..979a56a 100755
--- a/scripts/protocol
+++ b/scripts/protocol
@@ -311,7 +311,6 @@ string_login("confirm",
 	     "Confirm registration",
 	     "The confirmation string must have been created with 'register'.  The username is returned so the caller knows who they are.",
 	     [["confirmation", "Confirmation string"]]);
-#TODO update docs - this logs you in
 
 string_login("cookie",
 	     "Log in with a cookie",