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

Deprecating "libraries" in opam files #4519

Open
emillon opened this issue Feb 3, 2021 · 3 comments
Open

Deprecating "libraries" in opam files #4519

emillon opened this issue Feb 3, 2021 · 3 comments
Projects

Comments

@emillon
Copy link
Contributor

emillon commented Feb 3, 2021

The "libraries" field is supported but does not seem that anything in the ecosystem is using it:

(** List of exported libraries *)
val libraries: t -> (string * filter option) list

Might be worth deprecating it in 2.1 or 2.2.

@dra27 dra27 added this to To do in Opam 2.2.0 via automation Jun 25, 2021
@dra27 dra27 added this to the 2.2.0~alpha milestone Jun 25, 2021
@dra27
Copy link
Member

dra27 commented Jun 25, 2021

The plan here:

  • Double-check the lack of use and add an opam lint warning (all versions)
  • When the opam file format itself is updated, remove the field

The lint warning forms the "deprecation" stage, since this field has no interpretation at present.

@AltGr
Copy link
Member

AltGr commented Jan 4, 2022

I think that was a planned feature in 1.0 (when it was not clear if ocamlfind would be replaced) but never got any use; it was already deprecated in 2.0 and I think we can remove it altogether since it has always been absent from the manual. After double-checking that it's absent from opam-repo of course.

The exact same is probably true for the syntax: field as well ?

@dra27 dra27 removed this from To do: opam file updates in Opam 2.2.0 May 17, 2022
@dra27 dra27 added this to To do in Opam 2.3 via automation May 17, 2022
@dra27 dra27 removed this from the 2.2.0~alpha milestone May 17, 2022
@kit-ty-kate
Copy link
Member

maybe we don’t want to remove that. See ocaml/dune#8650
In practice for that purpose it’s the same as having an x-* field but maybe we want to use it instead so we can have a feature to install a library like opam install --lib findlib to install ocamlfind

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Opam 2.3
  
To do
Development

No branches or pull requests

4 participants