From 9156da13d458bb77c47922718ef31cbac7f382e5 Mon Sep 17 00:00:00 2001 From: Matthew Yacavone Date: Thu, 6 Jul 2023 16:57:20 -0400 Subject: [PATCH] update docs with version command --- cryptol-remote-api/docs/Cryptol.rst | 46 +++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) diff --git a/cryptol-remote-api/docs/Cryptol.rst b/cryptol-remote-api/docs/Cryptol.rst index fab75c3b1..d8fe93a44 100644 --- a/cryptol-remote-api/docs/Cryptol.rst +++ b/cryptol-remote-api/docs/Cryptol.rst @@ -237,6 +237,52 @@ JSON representations of types are type schemas. A type schema has three fields: Methods ------- +version (command) +~~~~~~~~~~~~~~~~~ + +Version information about this Cryptol server. + +Parameter fields +++++++++++++++++ + +No parameters + + +Return fields ++++++++++++++ + + +``RPC server version`` + The cryptol-remote-api version string. + + + +``version`` + The Cryptol version string. + + + +``commit hash`` + The string of the git commit hash during the build of Cryptol. + + + +``commit branch`` + The string of the git commit branch during the build of Cryptol. + + + +``commit dirty`` + True iff non-committed files were present during the build of Cryptol. + + + +``FFI enabled`` + True iff the FFI is enabled. + + + + check (command) ~~~~~~~~~~~~~~~