Skip to content

Commit 1b4a3ad

Browse files
art-wLeonidas-from-XIV
authored andcommitted
Document maintenance_intent
Signed-off-by: ArthurW <arthur@tarides.com> Signed-off-by: Marek Kubica <marek@tarides.com>
1 parent f4b439b commit 1b4a3ad

File tree

4 files changed

+23
-0
lines changed

4 files changed

+23
-0
lines changed

doc/changes/11274.md

Lines changed: 1 addition & 0 deletions
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

Lines changed: 2 additions & 0 deletions
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 "team@mirage.org")
92+
(maintenance_intent "(latest)")
9193

9294
(package
9395
(name cohttp-async)

doc/reference/dune-project/generate_opam_files.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,19 @@ defined in the project:
6363
"Jane Doe <jane.doe@example.com>"
6464
"John Doe <john.doe@example.com>")
6565
66+
.. _maintenance_intent:
67+
.. describe:: (maintenance_intent <strings>)
68+
69+
.. versionadded:: 3.18
70+
71+
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>`__.
72+
73+
Example:
74+
75+
.. code:: dune
76+
77+
(maintenance_intent "(latest)")
78+
6679
.. describe:: (source ...)
6780

6881
.. versionadded:: 1.7

doc/reference/dune-project/package.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,13 @@ 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+
See :doc:`the global field for details </reference/dune-project/generate_opam_files>`.
69+
6370
.. describe:: (source ...)
6471

6572
.. versionadded:: 2.0

0 commit comments

Comments
 (0)