Skip to content

Commit

Permalink
update docs with version command
Browse files Browse the repository at this point in the history
  • Loading branch information
m-yac committed Jul 6, 2023
1 parent 3d69f6d commit 9156da1
Showing 1 changed file with 46 additions and 0 deletions.
46 changes: 46 additions & 0 deletions cryptol-remote-api/docs/Cryptol.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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)
~~~~~~~~~~~~~~~

Expand Down

0 comments on commit 9156da1

Please sign in to comment.