CHANGES.md

Version 0.11.1:

• [sertop] Added option --topfile to sertop to set top name from a filename
• [deps] Require sexplib >= 0.12 , fixed deprecation warnings (#???, @ejgallego)
• [general] SerAPI is now tested with OCaml 4.08 and 4.09

Version 0.11.0:

• [general] (!) support Coq 8.11, a few datatypes have changed, in particular CoqAst handles locations as an AST node, and the kernel type includes primitive floats (@ejgallego).
• [general] (!) Now the sertop and serapi OCaml libraries are built packed, we've also bumped their compat version number (#192 @ejgallego)

Version 0.7.0:

• [general] (!) support Coq 8.10,
• [serapi] (!) Goals query return type has been modified due to upstream changes. (@ejgallego)
• [serlib] Complete (hopefully) serialization for ssreflect ASTs. (#73 @ejgallego)
• [general] Drop support for OCaml < 4.07 (#140 @ejgallego)
• [serlib ] JSON serialization for kernel and AST terms (@ejgallego)
• [serapi ] Add Complete support (@ejgallego c.f. coq/coq#8766)
• [serlib ] Serlib is now built as a wrapped module (@ejgallego)
• [serapi ] (!) Goals info has been extended to print name metadata if available, cc #151 (@ejgallego , suggested by @cpitclaudel)
• [serlib ] JSON support for vernac_expr (@ejgallego)
• [sertop ] (!) Do as Coq upstream and load Coq's stdlib with -R (closes #56)
• [sertop ] Follow Coq upstream and unset indices_matter (closes #157, thanks to @palmskog for the report)
• [serapi ] (!) Improve CoqExn answer to have pretty-printed message (improves #162, thanks to @cpitclaudel for the request)
• [serlib ] (!) Fix capitalization conventions for a few types in Names (closes #167 thanks to @corwin-of-amber for the report)
• [serapi ] (!) Add bullet suggest information to goal query (@corwin-of-amber)
• [sertop ] Add --no_prelude option (closes #176, @ejgallego, request of @darbyhaller)
• [serlib ] (!) Add index to MBId serialization (fixes #150, @ejgallego)
• [serapi ] (!) Add sid parameter to Print (helps #150, @ejgallego, reported by @cpitclaudel)
• [sertop ] Add sertok program for batch serialization of tokens and their source locations (@palmskog)
• [serapi ] (!) Add string-formatted messages to CoqExn and Message (@ejgallego closes #184 , closes #162)

Version 0.6.1:

• [serapi ] Add Parse command to parse a sentence; c.f. rocq-archive#117 (@ejgallego) (cc: @yangky11)
• [sercomp] Add "print" --mode to print the input Coq document (@ejgallego) (cc: @Ptival)
• [serlib ] Serialize Universe.t (@ejgallego, request by @yangky11)
• [sercomp] Merge sercomp and compser, add --input parameter to sercomp (@palmskog) (cc: @ejgallego)
• [serlib ] Much improved support for serialization of Environ.env (@yangky11 and @ejgallego c.f. #118)
• [serapi ] Make sure every command ends with Completed, even if it produced an exception (@brando90 and @ejgallego c.f. #124)
• [sercomp] Add --mode=kexp to output the final kernel environment. (@ejgallego c.f. #119)
• [serlib ] Serialize more internal environment fields (@ejgallego c.f. #119)
• [serlib ] Improvements in serialization org (@ejgallego)
• [serlib ] Serialize kernel entries (@ejgallego @palmskog)
• [serlib ] Fix critical bug on Constr deserialization; reported by @palmskog, fix by @SkySkimmer.
• [sertop] Fix backtrace printing when using --debug (@ejgallego)
• [serlib ] Don't serialize VM values (@ejgallego, bug report by @palmskog)
• [serapi ] Output location on tokenization (@ejgallego , idea by @palmskog)
• [serapi ] Add basic documentation of the protocol (@ejgallego cc #109)

Version 0.6.0:

• [general] support Coq 8.9,
• [general] SerAPI now uses Dune as a build system,
• [opam] install sertop.el,
• [serlib] support to serialize kernel environments,
• [serapi] new query Env that tries to print the current kernel environment,
• [serlib] correct field names for CAst,
• [serlib] more robust support for opaque / non-serializable types (#61, #68). Thanks to @palmskog,
• [serlib] new option --exn_on_opaque to raise an exception on non-serializable types; closes #61, thanks to @palmskog,
• [serlib] serialization test-suite from https://github.com/proofengineering/serapi-tests, thanks to @palmskog,
• [sercomp] add --mode option to better control output,
• [sercomp] add compser for deserialization (inverse of sercomp) (@palmskog),
• [serapi] Allow custom document creation using the NewDoc call. Use the --no_init option to avoid automatic creation on init. (@ejgallego)
• [sercomp] Allow compilers to output .vo (@ejgallego , suggested by @palmskog)
• [sercomp] Serialize top-level vernaculars with their syntactic attributes (such as location) (@ejgallego)
• [serapi] Add Assumptions query, at the suggestion of @Armael (@ejgallego)
• [sercomp] Disable error resilience mode in compilers; semantics are a bit dubious see coq/coq#9204 also #94. (@ejgallego, report by @palmskog)
• [sercomp] Add check mode to compilers to check all proofs without outputting .vo. (@palmskog)
• [sercomp] Add "hacky" --quick option to skip checking of opaque proofs. (@ejgallego, request by @palmskog)
• [sercomp] Add --async_workers option to set maximum number of parallel async workers. (@palmskog)
• [sertop] Stop linking Coq plugins statically and load serlib plugins when Coq plugins are loaded instead (@ejgallego, review by @palmskog)

Version 0.5.7:

• [serlib] Fixed serializers for more tactics data, add support for ground plugin (#68). Thanks again to @palmskog for the report.

Version 0.5.6:

• [serlib] Fixed serializers for some tactics data (#66) Thanks to @palmskog for the report.

Version 0.5.5:

• [serlib] Be more lenient when parsing back Id.t as to accommodate hacks in the Coq AST (#64) Thanks to @palmskog for the report.

Version 0.5.4:

• [serlib] Fix critical bug in handling of abstract type (#60)

Version 0.5.3:

• [sertop] Support for -I option (--ml-include-path).

Version 0.5.2:

• [serlib] Compatibility with OCaml 4.07.0 [problems with Stdlib packing]

Version 0.5.1:

• [serlib] (basic) support for serialization of the ssreflect grammar,
• [serapi] (Query () (Ast n)) is now (Query ((sid n)) Ast),
• [serapi] remove broken deprecated SetOpt and LibAdd commands,
• [doc] Improved man page.
• [js] Miscellaneous improvements on the js build.

Version 0.5.0:

• [general] support Coq 8.8, use improved document API,
• [sertop] By default sertop will create a new document with doc_id 0,
• [sertop] new debug options, see sertop --help.

Version 0.4:

• [general] support Coq 8.7 , make use of improved upstream API,
• [sertop] support -R and -Q options, note the slightly different syntax wrt Coq upstream: -R dir,path in place of -R dir path,
• [serlib] support serialization of generic arguments [#41],
• [serapi] (ReadFile file): hack to load a completed file.

Version 0.2:

• Better Query/Object system.

Version 0.1:

• Serialization-independent protocol core,
• [js] Javascript worker,
• [lib] Better Prelude support,
• [serlib] Full Serialization of generic arguments,
• [proto] Add is not a synchronous call anymore,
• [proto] Refactor into a flat command hierarchy,
• [proto] More useful queries,
• [proto] Guarantee initial state is 1,
• [proto] Support for ltac profiling,
• [proto] Printing: add depth limiting,
• [proto] Better handling of options in the sexp backend.

Version 0.03:

• [done] Implicit arguments.
• [done] Coq Workers support.
• [done] Advanced Sentence splitting (Parse (Sentence string)), which can handle the whole document.

Version 0.02:

• [done] Serialization of the Proof.proof object.
• [done] Improve API: add options.
• [done] Improve and review printing workflow.
• [done] (Query ((Prefix "add") (Limit 10) (PpStr)) $ObjectType)
• [done] Basic Sentence splitting (Parse num string)), retuns the first num end of the sentences without executing them. This has pitfalls as parsing is very stateful.
• [done] Basic completion-oriented Search support (Query () Names)
• [done] Better command line parsing (Cmdliner, Core ?)
• [partial] Print Grammar tactic. (Query ... (Tactics)). Still we need to decide on: Coq.Init.Notations.instantiate vs instantiate, the issue of Nametab.shortest_qualid_of_global is a very sensible one for IDEs