Set ocaml-version to a fixed version by default to avoid reproducibility issues and surprising behaviours #2064
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ity issues and surprising behaviours
Julow
approved these changes
Apr 21, 2022
There was a problem hiding this comment.
This is the most correct behavior.
to the oldest version of the compiler to ever be compatible with ocamlformat.
It should be the oldest version of the compiler compatible with the programs that are formatted, this has never been specified but is perhaps close to 4.02 or 4.00. But that doesn't matter because this value is only compared against 4.13 and 4.14 for now.
gpetiot
approved these changes
May 3, 2022
This was referenced May 24, 2022
mseri
pushed a commit
to ocaml/opam-repository
that referenced
this pull request
May 26, 2022
CHANGES: ### Removed - Profiles `compact` and `sparse` are now removed (ocaml-ppx/ocamlformat#2075, @gpetiot) - Options `align-cases`, `align-constructors-decl` and `align-variants-decl` are now removed (ocaml-ppx/ocamlformat#2076, @gpetiot) - Option `disable-outside-detected-project` is now removed (ocaml-ppx/ocamlformat#2077, @gpetiot) ### Deprecated - Cancel the deprecations of options that are not set by the preset profiles (ocaml-ppx/ocamlformat#2074, @gpetiot) ### Bug fixes - emacs: Remove temp files in the event of an error (ocaml-ppx/ocamlformat#2003, @gpetiot) - Fix unstable comment formatting around prefix op (ocaml-ppx/ocamlformat#2046, @gpetiot) ### Changes - Qtest comments are not re-formatted (ocaml-ppx/ocamlformat#2034, @gpetiot) - ocamlformat-rpc is now distributed through the ocamlformat package (ocaml-ppx/ocamlformat#2035, @Julow) - Doc-comments code blocks with a language other than 'ocaml' (set in metadata) are not parsed as OCaml (ocaml-ppx/ocamlformat#2037, @gpetiot) - More comprehensible error message in case of version mismatch (ocaml-ppx/ocamlformat#2042, @gpetiot) - The global configuration file (`$XDG_CONFIG_HOME` or `$HOME/.config`) is only applied when no project is detected, `--enable-outside-detected-project` is set, and no applicable `.ocamlformat` file has been found. Global and local configurations are no longer used at the same time. (ocaml-ppx/ocamlformat#2039, @gpetiot) - Set `ocaml-version` to a fixed version (4.04.0) by default to avoid reproducibility issues and surprising behaviours (ocaml-ppx/ocamlformat#2064, @kit-ty-kate) - Split option `--numeric=X-Y` into `--range=X-Y` and `--numeric` (flag). For now `--range` can only be used with `--numeric`. (ocaml-ppx/ocamlformat#2073, ocaml-ppx/ocamlformat#2082, @gpetiot) ### New features - New syntax `(*= ... *)` for verbatim comments (ocaml-ppx/ocamlformat#2028, @gpetiot) - Preserve the begin-end construction in the AST (ocaml-ppx/ocamlformat#1785, @hhugo, @gpetiot) - Preserve position of comments located after the semi-colon of the last element of lists/arrays/records (ocaml-ppx/ocamlformat#2032, @gpetiot) - Option `--print-config` displays a warning when an .ocamlformat file defines redundant options (already defined by a profile) (ocaml-ppx/ocamlformat#2084, @gpetiot)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
See for example ocaml/opam-repository#21236 (comment)
To me, ocamlformat should always aim to give a reproducible output regardless of the version of the compiler you currently have. To this end I’m setting the default value of
ocaml-versionto the oldest version of the compiler to ever be compatible with ocamlformat.