aboutsummaryrefslogtreecommitdiff
path: root/doc/sphinx/proof-engine
diff options
context:
space:
mode:
authorPierre-Marie Pédrot2020-03-12 16:24:27 +0100
committerPierre-Marie Pédrot2020-03-18 11:58:06 +0100
commit7b124ee24aa6ebaf14c5f7019949a7c2a877dedb (patch)
tree8420ae7f5bc4fde8f6669c7f1fe071f9cfe7ef64 /doc/sphinx/proof-engine
parentd583f810be066929301864765601ff53497bc335 (diff)
Add documentation for the export hint.
Diffstat (limited to 'doc/sphinx/proof-engine')
-rw-r--r--doc/sphinx/proof-engine/tactics.rst25
-rw-r--r--doc/sphinx/proof-engine/vernacular-commands.rst6
2 files changed, 24 insertions, 7 deletions
diff --git a/doc/sphinx/proof-engine/tactics.rst b/doc/sphinx/proof-engine/tactics.rst
index 4f2f74aae4..be185e885b 100644
--- a/doc/sphinx/proof-engine/tactics.rst
+++ b/doc/sphinx/proof-engine/tactics.rst
@@ -3759,6 +3759,24 @@ automatically created.
.. cmd:: Hint @hint_definition : {+ @ident}
The general command to add a hint to some databases :n:`{+ @ident}`.
+
+ This command supports the :attr:`local`, :attr:`global` and :attr:`export`
+ locality attributes. When no locality is explictly given, the
+ command is :attr:`local` inside a section and :attr:`global` otherwise.
+
+ + :attr:`local` hints are never visible from other modules, even if they
+ require or import the current module. Inside a section, the :attr:`local`
+ attribute is useless since hints do not survive anyway to the closure of
+ sections.
+
+ + :attr:`export` are visible from other modules when they import the current
+ module. Requiring it is not enough. This attribute is only effective for
+ the :cmd:`Hint Resolve`, :cmd:`Hint Immediate`, :cmd:`Hint Unfold` and
+ :cmd:`Hint Extern` variants of the command.
+
+ + :attr:`global` hints are made available by merely requiring the current
+ module.
+
The various possible :production:`hint_definition`\s are given below.
.. cmdv:: Hint @hint_definition
@@ -3767,13 +3785,6 @@ automatically created.
.. deprecated:: 8.10
- .. cmdv:: Local Hint @hint_definition : {+ @ident}
-
- This is used to declare hints that must not be exported to the other modules
- that require and import the current module. Inside a section, the flag
- Local is useless since hints do not survive anyway to the closure of
- sections.
-
.. cmdv:: Hint Resolve @qualid {? | {? @num} {? @pattern}} : @ident
:name: Hint Resolve
diff --git a/doc/sphinx/proof-engine/vernacular-commands.rst b/doc/sphinx/proof-engine/vernacular-commands.rst
index d1f3dcc309..4401f8fa2f 100644
--- a/doc/sphinx/proof-engine/vernacular-commands.rst
+++ b/doc/sphinx/proof-engine/vernacular-commands.rst
@@ -1190,6 +1190,12 @@ Controlling the locality of commands
occurs in a section. The :cmd:`Set` and :cmd:`Unset` commands belong to this
category.
+.. attr:: export
+
+ Some commands support an :attr:`export` attribute. The effect of the attribute
+ is to make the effect of the command available when the module containing it
+ is imported. The :cmd:`Hint` command accepts it for instance.
+
.. _controlling-typing-flags:
Controlling Typing Flags