Add clarifications in the documentation of the `query` command
- Add a statement that the result is always for the latest patch set,
even if the query matched on an earlier patch set
- Add a link to the change attribute documentation from the JSON
format option description.
- Add clarification in the change attribute documentation that the
commit message is of the latest patch set.
- Correct a minor typo
Change-Id: Ie6a825d1d183994926662c0ad8c42ec15f687e51
diff --git a/Documentation/cmd-query.txt b/Documentation/cmd-query.txt
index f28b4f5..66bd845 100644
--- a/Documentation/cmd-query.txt
+++ b/Documentation/cmd-query.txt
@@ -28,7 +28,9 @@
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 @@
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 @@
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 3659ed3..3893e3f 100644
--- a/Documentation/json.txt
+++ b/Documentation/json.txt
@@ -28,7 +28,8 @@
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.
