Document maintenance_intent

Signed-off-by: ArthurW <[email protected]>
ocaml · Jan 8, 2025 · 7b81397 · 7b81397
1 parent 635098f
commit 7b81397
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 0 deletions.
diff --git a/doc/changes/11274.md b/doc/changes/11274.md
@@ -0,0 +1 @@
+- Support for opam `(maintenance_intent ...)` in dune-project (#11274, @art-w)
diff --git a/doc/howto/opam-file-generation.rst b/doc/howto/opam-file-generation.rst
@@ -81,13 +81,15 @@ For example, if your opam file looks like:
      "conduit-async" { >= "1.0.3" }
      "async" { >= "v0.10.0" }
    ]
+   x-maintenance-intent: [ "(latest)" ]
 
 You can express this as::
 
    (source (github mirage/ocaml-cohttp))
    (license ISC)
    (authors "Anil Madhavapeddy" "Rudi Grinberg")
    (maintainers "[email protected]")
+   (maintenance_intent "(latest)")
 
    (package
     (name cohttp-async)

diff --git a/doc/reference/dune-project/generate_opam_files.rst b/doc/reference/dune-project/generate_opam_files.rst
@@ -63,6 +63,18 @@ defined in the project:
        "Jane Doe <[email protected]>"
        "John Doe <[email protected]>")
 
+.. describe:: (maintenance_intent <strings>)
+
+   .. versionadded:: 3.18
+
+   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>`__.
+
+   Example:
+
+   .. code:: dune
+
+      (maintenance_intent "(latest)")
+
 .. describe:: (source ...)
 
    .. versionadded:: 1.7

diff --git a/doc/reference/dune-project/package.rst b/doc/reference/dune-project/package.rst
@@ -60,6 +60,12 @@ package
 
       The same as (and takes precedences over) the corresponding global field.
 
+   .. describe:: (maintenance_intent ...)
+
+      .. versionadded:: 3.18
+
+      The same as (and takes precedences over) the corresponding global field.
+
    .. describe:: (source ...)
 
       .. versionadded:: 2.0
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		- Support for opam `(maintenance_intent ...)` in dune-project (#11274, @art-w)