opendev/gerrit
Code Issues Proposed changes

Merge "Add clarifications in the documentation of the query command" into stable-2.6

Browse Source
This commit is contained in:
Edwin Kempin
2013-05-03 05:33:22 +00:00
committed by Gerrit Code Review
parent 356a7a143b 93a4ae6cb0
commit ddf5dbb617
2 changed files with 9 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
Documentation/cmd-query.txt
View File

@@ -28,7 +28,9 @@ DESCRIPTION
Queries the change database and returns results describing changes Queries the change database and returns results describing changes
that match the input query. More recently updated changes appear that match the input query. More recently updated changes appear
before older changes, which is the same order presented in the before older changes, which is the same order presented in the
web interface. web interface. For each matching change, the result contains data
for the change's latest patch set, even if the query matched on an
older patch set (for example an older patch set's sha1 revision).
A query may be limited on the number of results it returns with the A query may be limited on the number of results it returns with the
'limit:' operator. If no limit is supplied an internal default 'limit:' operator. If no limit is supplied an internal default
@@ -41,7 +43,7 @@ Non-option arguments to this command are joined with spaces and
then parsed as a query. This simplifies calling conventions over then parsed as a query. This simplifies calling conventions over
SSH by permitting operators to appear in different arguments. SSH by permitting operators to appear in different arguments.
Query operators may quote values using matched curly braches Query operators may quote values using matched curly braces
(e.g. `reviewerin:{Developer Group}`) to sidestep issues with 2 (e.g. `reviewerin:{Developer Group}`) to sidestep issues with 2
levels of shell quoting (caller shell invoking SSH, and the SSH levels of shell quoting (caller shell invoking SSH, and the SSH
command line parser in the server). command line parser in the server).
@@ -49,8 +51,9 @@ command line parser in the server).
OPTIONS OPTIONS
------- -------
--format:: --format::
Formatting method for the results. TEXT is the default, Formatting method for the results. `TEXT` is the default,
presenting a human readable display. JSON creates one line presenting a human readable display. `JSON` returns
link:json.html#change[change attributes], one line
per matching record, with embedded LFs escaped. per matching record, with embedded LFs escaped.
--current-patch-set:: --current-patch-set::

3
Documentation/json.txt
View File

@@ -28,7 +28,8 @@ owner:: Owner in <<account,account attribute>>.
url:: Canonical URL to reach this change. url:: Canonical URL to reach this change.
commitMessage:: The full commit message for the change. commitMessage:: The full commit message for the change's current patch
set.
createdOn:: Time in seconds since the UNIX epoch when this change createdOn:: Time in seconds since the UNIX epoch when this change
was created. was created.