1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
|
Writing Coq libraries and plugins
===================================
This section presents the part of the Coq language that is useful only
to library and plugin authors. A tutorial for writing Coq plugins is
available in the Coq repository in `doc/plugin_tutorial
<https://github.com/coq/coq/tree/master/doc/plugin_tutorial>`_.
Deprecating library objects, tactics or library files
-----------------------------------------------------
You may use the following :term:`attribute` to deprecate a notation,
tactic, definition, axiom, theorem or file. When renaming a definition or theorem, you can introduce a
deprecated compatibility alias using :cmd:`Notation (abbreviation)`
(see :ref:`the example below <compatibility-alias>`).
.. attr:: deprecated ( {? since = @string , } {? note = @string } )
:name: deprecated
At least one of :n:`since` or :n:`note` must be present. If both
are present, either one may appear first and they must be separated
by a comma. If they are present, they will be used in the warning
message, and :n:`since` will also be used in the warning name and
categories. Spaces inside :n:`since` are changed to hyphens.
This attribute is supported by the following commands: :cmd:`Ltac`,
:cmd:`Tactic Notation`, :cmd:`Notation`, :cmd:`Infix`, :cmd:`Ltac2`,
:cmd:`Ltac2 Notation`, :cmd:`Ltac2 external`, :cmd:`Definition`,
:cmd:`Theorem`, and similar commands. To attach it to a
compiled library file, use :cmd:`Attributes`.
It can trigger the following warnings:
.. warn:: Library File @qualid is deprecated since @string__since. @string__note
Library File (transitively required) @qualid is deprecated since @string__since. @string__note
Ltac2 alias @qualid is deprecated since @string__since. @string__note
Ltac2 definition @qualid is deprecated since @string__since. @string__note
Ltac2 notation {+ @ltac2_scope } is deprecated since @string__since. @string__note
Notation @string is deprecated since @string__since. @string__note
Tactic @qualid is deprecated since @string__since. @string__note
Tactic Notation @qualid is deprecated since @string__since. @string__note
:n:`@qualid` or :n:`@string` is the notation,
:n:`@string__since` is the version number, :n:`@string__note` is
the note (usually explains the replacement).
Explicitly :cmd:`Require`\ing a file that has been deprecated,
using the :cmd:`Attributes` command, triggers a ``Library File``
deprecation warning. Requiring a deprecated file, even indirectly through a chain of
:cmd:`Require`\s, will produce a
``Library File (transitively required)`` deprecation warning
if the :opt:`Warnings` option "deprecated-transitive-library-file"
is set (it is "-deprecated-transitive-library-file" by default, silencing the warning).
.. note::
Coq and its standard library follow this deprecation policy:
* it should always be possible for a project written in Coq to be
compatible with two successive major versions,
* features must be deprecated in one major version before removal,
* Coq developers should provide an estimate of the required effort
to fix a project with respect to a given change,
* breaking changes should be clearly documented in the public
release notes, along with recommendations on how to fix a project
if it breaks.
See :cite:`Zimmermann19`, Section 3.6.3, for more details.
Triggering warning for library objects or library files
-------------------------------------------------------
You may use the following :term:`attribute` to trigger a warning on a
notation, definition, axiom, theorem or file.
.. attr:: warn ( note = @string , {? cats = @string } )
:name: warn
The :n:`note` field will be used as the warning message, and
:n:`cats` is a comma separated list of categories to be used in the
warning name and categories. Leading and trailing spaces in each
category are trimmed, whereas internal spaces are changed to
hyphens. If both :n:`note` and :n:`cats` are present, either one
may appear first and they must be separated by a comma.
This attribute is supported by the following commands:
:cmd:`Notation`, :cmd:`Infix`, :cmd:`Definition`, :cmd:`Theorem`,
and similar commands. To attach it to a compiled library file, use
:cmd:`Attributes`.
It can trigger the following warning:
.. warn:: @string__note
:n:`@string__note` is the note. It's common practice to start it
with a capital and end it with a period.
Explicitly :cmd:`Require`\ing a file that has a warn message set
using the :cmd:`Attributes` command, triggers a
``warn-library-file`` warning. Requiring such a file, even
indirectly through a chain of :cmd:`Require`\s, will produce a
``warn-transitive-library-file`` warning if the :opt:`Warnings`
option "warn-transitive-library-file" is set (it is
"-warn-transitive-library-file" by default, silencing the
warning).
.. example:: Deprecating a tactic.
.. coqtop:: all abort warn
#[deprecated(since="mylib 0.9", note="Use idtac instead.")]
Ltac foo := idtac.
Goal True.
Proof.
now foo.
.. _compatibility-alias:
.. example:: Introducing a compatibility alias
Let's say your library initially contained:
.. coqtop:: in
Definition foo x := S x.
and you want to rename `foo` into `bar`, but you want to avoid breaking
your users' code without advanced notice. To do so, replace the previous
code by the following:
.. coqtop:: in reset
Definition bar x := S x.
#[deprecated(since="mylib 1.2", note="Use bar instead.")]
Notation foo := bar (only parsing).
Then, the following code still works, but emits a warning:
.. coqtop:: all warn
Check (foo 0).
|
