Fix outdated documentation for users-setup
authorMichele Tartara <mtartara@google.com>
Mon, 7 Oct 2013 07:51:30 +0000 (07:51 +0000)
committerMichele Tartara <mtartara@google.com>
Mon, 7 Oct 2013 08:02:17 +0000 (08:02 +0000)
The --yes-do-it parameter was not properly documented yet. Add it to the
administration guide.

Signed-off-by: Michele Tartara <mtartara@google.com>
Reviewed-by: Klaus Aehlig <aehlig@google.com>

doc/admin.rst

index 6859543..dd45a04 100644 (file)
@@ -1791,7 +1791,11 @@ permissions to files and programs to be correct.
 The ``users-setup`` tool, when run, takes care of setting up the proper
 users and groups.
 
 The ``users-setup`` tool, when run, takes care of setting up the proper
 users and groups.
 
-The tool does not accept any parameter, and requires root permissions to run.
+When invoked without parameters, the tool runs in interactive mode, showing the
+list of actions it will perform and asking for confirmation before proceeding.
+
+Providing the ``--yes-do-it`` parameter to the tool prevents the confirmation
+from being asked, and the users and groups will be created immediately.
 
 .. TODO: document cluster-merge tool
 
 
 .. TODO: document cluster-merge tool