Skip to content

Commit c6d3bb2

Browse files
authored
Merge pull request #5885 from kit-ty-kate/doc-with-dev-setup-since-2.2
Manual: add missing 'since opam 2.2' annotation when mentionning with-dev-setup
2 parents 0a82116 + f0e189f commit c6d3bb2

File tree

2 files changed

+10
-9
lines changed

2 files changed

+10
-9
lines changed

doc/pages/Manual.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -408,10 +408,10 @@ three scopes:
408408
`_:bar`, always refers to the version being defined.
409409

410410
3. Some fields define their own local variables, like `success` and
411-
[`with-dev-setup`](#pkgvar-with-dev-setup) in the field
411+
[`with-dev-setup`](#pkgvar-with-dev-setup) (since opam 2.2) in the field
412412
[`post-messages`](#opamfield-post-messages). Other examples of this include
413413
the [`with-test`](#pkgvar-with-test), [`with-doc`](#pkgvar-with-doc) and
414-
[`with-dev-setup`](#pkgvar-with-dev-setup) variables, available in the
414+
[`with-dev-setup`](#pkgvar-with-dev-setup) (since opam 2.2) variables, available in the
415415
`depends:`, `depopts:`, `build:`, `install:` and `remove:` fields.
416416

417417
Within package definition files, the variables `name` and `version`, as
@@ -521,8 +521,8 @@ Additionally, the following are limited to some package fields (`depends:`,
521521
- <a id="pkgvar-with-test">`with-test`</a>: only true if tests have been
522522
enabled for this specific package
523523
- <a id="pkgvar-with-doc">`with-doc`</a>: similarly for documentation
524-
- <a id="pkgvar-with-dev-setup">`with-dev-setup`</a>: similarly for developer
525-
tools
524+
- <a id="pkgvar-with-dev-setup">`with-dev-setup`</a> (since opam 2.2):
525+
similarly for developer tools
526526

527527

528528
The following are only available in the `depends:` and `depopts:` fields, and
@@ -920,7 +920,7 @@ files.
920920
the command's `$PWD`, during this step.
921921

922922
The [`with-test`](#pkgvar-with-test), [`with-doc`](#pkgvar-with-doc), and
923-
[`with-dev-setup`](#pkgvar-with-dev-setup) variables are available in the
923+
[`with-dev-setup`](#pkgvar-with-dev-setup) (since opam 2.2) variables are available in the
924924
scope of this field: filter testing commands with _e.g._ `[make "test"]
925925
{with-test}`. The `dev` variable can also be useful here to detect that the
926926
package is not installed from a release tarball, and may need additional
@@ -948,7 +948,7 @@ files.
948948
`install:` field have been run, if any.
949949

950950
Variables [`with-test`](#pkgvar-with-test), [`with-doc`](#pkgvar-with-doc),
951-
and [`with-dev-setup`](#pkgvar-with-dev-setup) are also available to the
951+
and [`with-dev-setup`](#pkgvar-with-dev-setup) (since opam 2.2) are also available to the
952952
filters used in this field, to run specific installation commands when
953953
tests or documentation have been requested.
954954

@@ -992,7 +992,7 @@ files.
992992
not variables from other packages. Additionally, special boolean variables
993993
[`build`](#pkgvar-build), [`post`](#pkgvar-post),
994994
[`with-test`](#pkgvar-with-test), [`with-doc`](#pkgvar-with-doc), and
995-
[`with-dev-setup`](#pkgvar-with-dev-setup) are defined to allow limiting
995+
[`with-dev-setup`](#pkgvar-with-dev-setup) (since opam 2.2) are defined to allow limiting
996996
the scope of the dependency.
997997

998998
* `build` dependencies are no longer needed at run-time: they won't trigger
@@ -1006,7 +1006,7 @@ files.
10061006
package is explicitly installed with `--with-test`)
10071007
* likewise, `with-doc` dependencies are only required when building the
10081008
package documentation
1009-
* likewise, `with-dev-setup` dependencies are only required for a developer
1009+
* likewise, `with-dev-setup` (since opam 2.2) dependencies are only required for a developer
10101010
tool
10111011

10121012
- <a id="opamfield-depopts">
@@ -1081,7 +1081,7 @@ files.
10811081
and can be used to print messages in case there was an error (typically, a
10821082
hint on how it can be resolved, or a link to an open issue). `success` is also
10831083
defined as syntactic sugar for `!failure`. The
1084-
[`with-dev-setup`](#pkgvar-with-dev-setup) variable is also available in the
1084+
[`with-dev-setup`](#pkgvar-with-dev-setup) (since opam 2.2) variable is also available in the
10851085
scope of this field.
10861086

10871087
- <a id="opamfield-available">`available: [ <filter> ]`</a>:

master_changes.md

+1
Original file line numberDiff line numberDiff line change
@@ -143,6 +143,7 @@ users)
143143
* Fix the documentation of opam lint --warnings [#5818 @kit-ty-kate]
144144
* Fix a dead link to SPDX license expressions spec [#5849 @kit-ty-kate - fix #5846]
145145
* Fix missing spaces in `opam --help` [#5850 @sorawee].
146+
* Manual: add missing 'since opam 2.2' annotation when mentionning with-dev-setup [#5885 @kit-ty-kate]
146147

147148
## Security fixes
148149

0 commit comments

Comments
 (0)