Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Manual: add information when flags (avoid-version, deprecated) were introduced #6320

Merged
merged 1 commit into from
Dec 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions doc/pages/Manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -1154,11 +1154,12 @@ files.
[solver criteria](#configfield-solver-criteria). This can be useful for
beta releases, or to discourage installation of releases with known bugs.
Note that this behaviour is disabled when a flagged version of the package
is already installed.
is already installed. This was introduced in opam 2.1.
- <a id="opamflag-deprecated">`deprecated`</a>: this flag is equivalent to
[`avoid-version`](#opamflag-avoid-version) except for the addition of a
deprecation message after the package is installed as well as marked as
deprecated in the solution shown to the user upon installation.
deprecated in the solution shown to the user upon installation. This was
introduced in opam 2.2.

- <a id="opamfield-features">
`features: [ <ident> { <pkgname> { <filtered-package-formula> } ... } { <string> } ... ]`
Expand Down
1 change: 1 addition & 0 deletions master_changes.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,7 @@ users)
* Manual: Document the stamp field from repo files [#6306 @kit-ty-kate]
* Fix typo in pin edit man page doc [#6315 @shym]
* Clarify documentation for `enable` pseudo-variable [#5659 @gridbugs]
* Manual: add information when flags (`avoid-version`, `deprecated`) were introduced [#6320 @hannesm]

## Security fixes

Expand Down