Skip to content

Commit 7b81397

Browse files
committed
Document maintenance_intent
Signed-off-by: ArthurW <[email protected]>
1 parent 635098f commit 7b81397

File tree

4 files changed

+21
-0
lines changed

4 files changed

+21
-0
lines changed

doc/changes/11274.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
- Support for opam `(maintenance_intent ...)` in dune-project (#11274, @art-w)

doc/howto/opam-file-generation.rst

+2
Original file line numberDiff line numberDiff line change
@@ -81,13 +81,15 @@ For example, if your opam file looks like:
8181
"conduit-async" { >= "1.0.3" }
8282
"async" { >= "v0.10.0" }
8383
]
84+
x-maintenance-intent: [ "(latest)" ]
8485
8586
You can express this as::
8687

8788
(source (github mirage/ocaml-cohttp))
8889
(license ISC)
8990
(authors "Anil Madhavapeddy" "Rudi Grinberg")
9091
(maintainers "[email protected]")
92+
(maintenance_intent "(latest)")
9193

9294
(package
9395
(name cohttp-async)

doc/reference/dune-project/generate_opam_files.rst

+12
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,18 @@ defined in the project:
6363
"Jane Doe <[email protected]>"
6464
"John Doe <[email protected]>")
6565
66+
.. describe:: (maintenance_intent <strings>)
67+
68+
.. versionadded:: 3.18
69+
70+
Specify the `opam maintenance intent <https://github.com/ocaml/opam-repository/blob/master/governance/policies/archiving.md#specification-of-the-x--fields-used-in-the-archiving-process>`__.
71+
72+
Example:
73+
74+
.. code:: dune
75+
76+
(maintenance_intent "(latest)")
77+
6678
.. describe:: (source ...)
6779

6880
.. versionadded:: 1.7

doc/reference/dune-project/package.rst

+6
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,12 @@ package
6060

6161
The same as (and takes precedences over) the corresponding global field.
6262

63+
.. describe:: (maintenance_intent ...)
64+
65+
.. versionadded:: 3.18
66+
67+
The same as (and takes precedences over) the corresponding global field.
68+
6369
.. describe:: (source ...)
6470

6571
.. versionadded:: 2.0

0 commit comments

Comments
 (0)