opendev/gerrit
Code Issues Proposed changes

Improve documentation of the create-account command

Browse Source 
The command is not only used to create batch/role access accounts.
Change the description to a more generic "Create a new user account".

When an account is created without email address, then it may only
be used as batch/role access.  Add a clarification that in this case
the account must be explicitly added to the 'Non-Interactive Users'
group with the `--group` option.

Update the example to use the `--group` option to demonstrate adding
the new user to the 'Non-Interactive Users' group.

Change-Id: I287c05893340a064b53139b90b4a12913dc043b0
This commit is contained in:
David Pursehouse
2013-08-24 12:04:52 +09:00
parent 2de365c05f
commit c268399762
2 changed files with 9 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
Documentation/cmd-create-account.txt
View File

@@ -3,7 +3,7 @@ gerrit create-account
NAME
----
gerrit create-account - Create a new batch/role account.
gerrit create-account - Create a new user account.
SYNOPSIS
--------
@@ -24,6 +24,10 @@ If the account is created without an email address, it may only be
used for batch/role access, such as from an automated build system
or event monitoring over link:cmd-stream-events.html[gerrit stream-events].
Note, however, that in this case the account is not implicitly added
to the 'Non-Interactive Users' group. The account must be explicitly
added to the group with the `--group` option.
If LDAP authentication is being used, the user account is created
without checking the LDAP directory. Consequently users can be
created in Gerrit that do not exist in the underlying LDAP directory.
@@ -67,10 +71,11 @@ This most likely requires double quoting the value, for example
EXAMPLES
--------
Create a new user account called `watcher`:
Create a new batch/role access user account called `watcher` in
the 'Non-Interactive Users' group.
====
$ cat ~/.ssh/id_watcher.pub | ssh -p 29418 review.example.com gerrit create-account --ssh-key - watcher
$ cat ~/.ssh/id_watcher.pub | ssh -p 29418 review.example.com gerrit create-account --group "'Non-Interactive Users'" --ssh-key - watcher
====
GERRIT

2
Documentation/cmd-index.txt
View File

@@ -100,7 +100,7 @@ review. See link:user-upload.html#push_create[Creating Changes].
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
link:cmd-create-account.html[gerrit create-account]::
Create a new batch/role account.
Create a new user account.
link:cmd-set-account.html[gerrit set-account]::
Change an account's settings.