aboutsummaryrefslogtreecommitdiff
path: root/dev
diff options
context:
space:
mode:
authorMaxime Dénès2017-10-06 11:21:51 +0200
committerMaxime Dénès2017-10-06 11:21:51 +0200
commit82b39aa48e406688d4c1aae22c059bf155f03cc9 (patch)
treeedaceb087143a4c69ee36e717aa68e198eaf00df /dev
parente22bc3f687533aec3ae28a0ef0ffab74096d7b26 (diff)
parent2b90d0a7b0ff591f27b6b31ec3b0730a6502d2e3 (diff)
Merge PR #1131: Clean-up xml protocol doc
Diffstat (limited to 'dev')
-rw-r--r--dev/doc/changes.md6
-rw-r--r--dev/doc/xml-protocol.md8
2 files changed, 8 insertions, 6 deletions
diff --git a/dev/doc/changes.md b/dev/doc/changes.md
index 5ed74917aa..b5e19f33c3 100644
--- a/dev/doc/changes.md
+++ b/dev/doc/changes.md
@@ -641,6 +641,12 @@ The main search functions now take a function iterating over the
results. This allows for clients to use streaming or more economic
printing.
+### XML Protocol
+
+- In several places, flat text wrapped in `<string>` tags now appears as structured text inside `<richpp>` tags.
+
+- The "errormsg" feedback has been replaced by a "message" feedback which contains `<feedback\_content>` tag, with a message_level attribute of "error".
+
## Changes between Coq 8.4 and Coq 8.5
### Refactoring : more mli interfaces and simpler grammar.cma
diff --git a/dev/doc/xml-protocol.md b/dev/doc/xml-protocol.md
index cf7d205d8b..18f6288f6f 100644
--- a/dev/doc/xml-protocol.md
+++ b/dev/doc/xml-protocol.md
@@ -1,4 +1,4 @@
-#Coq XML Protocol for Coq 8.6#
+# Coq XML Protocol
This document is based on documentation originally written by CJ Bell
for his [vscoq](https://github.com/siegebell/vscoq/) project.
@@ -12,11 +12,7 @@ A somewhat out-of-date description of the async state machine is
[documented here](https://github.com/ejgallego/jscoq/blob/master/etc/notes/coq-notes.md).
OCaml types for the protocol can be found in the [`ide/interface.mli` file](/ide/interface.mli).
-# CHANGES
-## Changes from 8.5:
- * In several places, flat text wrapped in <string> tags now appears as structured text inside <richpp> tags
- * The "errormsg" feedback has been replaced by a "message" feedback which contains
- <feedback\_content> tag, with a message_level attribute of "error"
+Changes to the XML protocol are documented as part of [`dev/doc/changes.txt`](/dev/doc/changes.txt).
* [Commands](#commands)
- [About](#command-about)