summaryrefslogtreecommitdiffstats
path: root/Documentation
diff options
context:
space:
mode:
authorEdwin Kempin <edwin.kempin@gmail.com>2013-05-03 05:33:22 +0000
committerGerrit Code Review <noreply-gerritcodereview@google.com>2013-05-03 05:33:22 +0000
commitddf5dbb61747f7002ddf2634d3dec4114101defa (patch)
tree1a6818dc77637420d7fc0db05ba0274037f9dd85 /Documentation
parent356a7a143b1d7d74fb85aa0ef4fbc0ae57d2708d (diff)
parent93a4ae6cb0671a984c79b0a86979a389d4b97961 (diff)
Merge "Add clarifications in the documentation of the `query` command" into stable-2.6
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/cmd-query.txt11
-rw-r--r--Documentation/json.txt3
2 files changed, 9 insertions, 5 deletions
diff --git a/Documentation/cmd-query.txt b/Documentation/cmd-query.txt
index f28b4f53b8..66bd845281 100644
--- a/Documentation/cmd-query.txt
+++ b/Documentation/cmd-query.txt
@@ -28,7 +28,9 @@ DESCRIPTION
Queries the change database and returns results describing changes
that match the input query. More recently updated changes appear
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
'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
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
levels of shell quoting (caller shell invoking SSH, and the SSH
command line parser in the server).
@@ -49,8 +51,9 @@ command line parser in the server).
OPTIONS
-------
--format::
- Formatting method for the results. TEXT is the default,
- presenting a human readable display. JSON creates one line
+ Formatting method for the results. `TEXT` is the default,
+ presenting a human readable display. `JSON` returns
+ link:json.html#change[change attributes], one line
per matching record, with embedded LFs escaped.
--current-patch-set::
diff --git a/Documentation/json.txt b/Documentation/json.txt
index 3659ed31c7..3893e3f534 100644
--- a/Documentation/json.txt
+++ b/Documentation/json.txt
@@ -28,7 +28,8 @@ owner:: Owner in <<account,account attribute>>.
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
was created.