opendev
/
gerrit
Code Issues Proposed changes

Move 'User Refs' docs to the intro-user doc. 

Since there are more uses than just the named queries for the user refs
in All-Users, move the docs describing the refs to its own section where
it can be referenced by other sections.  Reference it from the 2 feature
sections which currently make use of it.

Change-Id: Ia95d25ca61df1c7df91dfd6bfede32acdcf65b20
This commit is contained in:
Martin Fick 2015-08-31 16:03:24 -06:00
parent ef64e7405a
commit 21c557b6fe
2 changed files with 17 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
Documentation/intro-user.txt
View File

@ -563,11 +563,23 @@ The project owner may enable link:user-upload.html#auto_merge[
auto-merge on push] to benefit from the automatic merge/rebase on
server side while pushing directly into the repository.
[[user-refs]]
== User Refs
User configuration data such as link:#preferences[preferences] is
stored in the `All-Users` project under a per-user ref. The user's
ref is based on the user's account id which is an integer. The user
refs are sharded by the last two digits (`+nn+`) in the refname,
leading to refs of the format `+refs/users/nn/accountid+`.
[[preferences]]
== Preferences
There are several options to control the rendering in the Gerrit web UI.
Users can configure their preferences under `Settings` > `Preferences`.
The user's preferences are stored in a `git config` style file named
`preferences.config` under the link:#user-refs[user's ref] in the
`All-Users` project.
The following preferences can be configured:

14
Documentation/user-named-queries.txt
View File

@ -3,15 +3,11 @@
[[user-named-queries]]
== User Named Queries
It is possible to define named queries on a user level. To do
this, define the named queries in the `queries` file of
the user's account ref in the `All-Users` project. The user's
account ref is based on the user's account id which is an
integer. The account refs are sharded by the last two digits
(`+nn+`) in the refname, leading to refs of the format
`+refs/users/nn/accountid+`. The user's queries file is a
2 column tab delimited file. The left column represents the
name of the query, and the right column represents the query
expression represented by the name.
this, define the named queries in the `queries` file under the
link:intro-user.html#user-refs[user's ref] in the `All-Users` project. The
user's queries file is a 2 column tab delimited file. The left
column represents the name of the query, and the right column
represents the query expression represented by the name.
Example queries file: