diff options
| author | Vincent Laporte | 2019-02-25 10:04:53 +0000 |
|---|---|---|
| committer | Vincent Laporte | 2019-02-25 10:05:35 +0000 |
| commit | e4c70510979209760956dc63f0aa15f969c8cf18 (patch) | |
| tree | f4da10a4caa73c74f7e1e0aa8e3bed12ccc9f951 | |
| parent | 43b2ddf9db407f6e5481974a626ac5c91d74910f (diff) | |
[Manual] Refactor documentation of internal registration commands
| -rw-r--r-- | doc/sphinx/proof-engine/vernacular-commands.rst | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/doc/sphinx/proof-engine/vernacular-commands.rst b/doc/sphinx/proof-engine/vernacular-commands.rst index 6c0290321d..3e8dd25ee0 100644 --- a/doc/sphinx/proof-engine/vernacular-commands.rst +++ b/doc/sphinx/proof-engine/vernacular-commands.rst @@ -1213,10 +1213,19 @@ Controlling the locality of commands occurs in a section. The :cmd:`Set` and :cmd:`Unset` commands belong to this category. +.. _internal-registration-commands: + +Internal registration commands +-------------------------------- + +Due to their internal nature, the commands that are presented in this section +are not for general use. They are meant to appear only in standard libraries and +in support libraries of plug-ins. + .. _exposing-constants-to-ocaml-libraries: Exposing constants to OCaml libraries ----------------------------------------------------------------- +```````````````````````````````````````````````````````````````` .. cmd:: Register @qualid__1 as @qualid__2 @@ -1225,9 +1234,6 @@ Exposing constants to OCaml libraries calling :n:`Coqlib.lib_ref "@qualid__2"`; i.e., there is no need to known where is the constant defined (file, module, library, etc.). - Due to its internal nature, this command is not for general use. It is meant - to appear only in standard libraries and in support libraries of plug-ins. - As a special case, when the first segment of :n:`@qualid__2` is :g:`kernel`, the constant is exposed to the kernel. For instance, the `Int63` module features the following declaration: @@ -1243,18 +1249,15 @@ Exposing constants to OCaml libraries .. seealso:: :ref:`primitive-integers` Inlining hints for the fast reduction machines ----------------------------------------------------------------- +```````````````````````````````````````````````````````````````` .. cmd:: Register Inline @qualid This command gives as a hint to the reduction machines (VM and native) that the body of the constant :n:`@qualid` should be inlined in the generated code. - Due to its internal nature, this command is not for general use. It is meant - to appear only in standard libraries and in support libraries of plug-ins. - Registering primitive operations --------------------------------- +```````````````````````````````` .. cmd:: Primitive @ident__1 := #@ident__2. @@ -1263,6 +1266,3 @@ Registering primitive operations the kernel (this is achieved through this command for primitive types and through the :cmd:`Register` command with the :g:`kernel` name-space for other types). - - Due to its internal nature, this command is not for general use. It is meant - to appear only in standard libraries and in support libraries of plug-ins. |
