From d8874dd855d748aaaf504890487ab15ffd7a677d Mon Sep 17 00:00:00 2001
From: Emilio Jesus Gallego Arias
Date: Mon, 12 Jun 2017 11:41:40 +0200
Subject: [ide] Add route_id parameter to query call.

This is necessary in order for clients to identify the results of
queries. This is a minor breaking change of the protocol, affecting
only this particular call.

This change is necessary in order to fix bug ####.
---
 dev/doc/changes.txt     | 4 ++++
 dev/doc/xml-protocol.md | 9 +++++++--
 2 files changed, 11 insertions(+), 2 deletions(-)

(limited to 'dev/doc')

diff --git a/dev/doc/changes.txt b/dev/doc/changes.txt
index 0728608f31..159be9a582 100644
--- a/dev/doc/changes.txt
+++ b/dev/doc/changes.txt
@@ -288,6 +288,10 @@ document type". This allows for a more uniform handling of printing
 
 - The legacy `Interp` call has been turned into a noop.
 
+- The `query` call has been modified, now it carries a mandatory
+  "route_id" integer parameter, that associated the result of such
+  query with its generated feedback.
+
 =========================================
 = CHANGES BETWEEN COQ V8.5 AND COQ V8.6 =
 =========================================
diff --git a/dev/doc/xml-protocol.md b/dev/doc/xml-protocol.md
index 2ff82c6888..127b4a6d2d 100644
--- a/dev/doc/xml-protocol.md
+++ b/dev/doc/xml-protocol.md
@@ -308,15 +308,20 @@ CoqIDE typically sets `force` to `false`.
 
 -------------------------------
 
+### <a name="command-query">**Query(route_id: integer, query: string, stateId: integer)**</a>
+
+`routeId` can be used to distinguish the result of a particular query,
+`stateId` should be set to the state the query should be run.
 
-### <a name="command-query">**Query(query: string, stateId: integer)**</a>
-In practice, `stateId` is 0, but the effect is to perform the query on the currently-focused state.
 ```html
 <call val="Query">
+  <pair>
+    <route_id val="${routeId}"/>
   <pair>
     <string>${query}</string>
     <state_id val="${stateId}"/>
   </pair>
+  </pair>
 </call>
 ```
 #### *Returns*
-- 
cgit v1.2.3