Document that 'confirm' logs user in
authorRichard Kettlewell <rjk@greenend.org.uk>
Sat, 5 Jun 2010 13:40:53 +0000 (14:40 +0100)
committerRichard Kettlewell <rjk@terraraq.org.uk>
Sat, 6 Aug 2011 17:19:07 +0000 (18:19 +0100)
doc/disorder_protocol.5.in
scripts/protocol

index b9ed984..f3cb615 100644 (file)
@@ -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.
index 46a1cbf..979a56a 100755 (executable)
@@ -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",