Release 2.2.0~beta3

Author: kit-ty-kate

CHANGES

@@ -3,6 +3,70 @@ repositories (changes that are automatically handled by the format upgrade tools
 are not marked). Those prefixed with "(+)" are new command/option (since
 2.1.0~alpha2).
 
+2.2.0~beta3:
+* (+) New option `opam init --cygwin-extra-packages=CYGWIN_PKGS --cygwin-internal-install`, to specify additional packages for internal Cygwin [#5930, #5964 @moyodiallo - fix #5834]
+* Redirect the opam root to C:\opamroot when the opam root contains spaces on Windows [#5457 @rjbou]
+* Out-of-the-box UTF-8 paged --help on Windows [#5970 @kit-ty-kate]
+* Sereval fixes were done related to environment reverting:
+  * Fix reverting of environment variables, principally on Windows [#5935 @dra27 fix #5838]
+  * Fix splitting environment variables [#5935 @dra27]
+  * When opam creates an empty variable then appends/prepends a value, ensure no additional separator is added [#5935 @dra27 - fix #5925]
+  * Fix `x-env-path-rewrite` splitting of values when reverting [#5935 @dra27 - fix #5838]
+  * Rework the logic of := and =: so that an empty entry is correctly preserved on multiple updates [#5935 @dra27 - fix #5926]
+  * Fix incorrect reverting of `=+` and `=:` [#5935 @dra27 - fix #5926]
+* Fix a performance regression when calling opam install --deps-only on an already installed package [#5908 @kit-ty-kate - fix #5817]
+* Fixed some issues that could appear when upgrading from previous versions of opam:
+  * Handle init OCaml `sys-ocaml-*` eval variables during format upgrade from 2.0 -> 2.1 -> 2.2 [#5829 @dra27]
+  * Reset the "jobs" config variable when upgrading from opam 2.1 to 2.2, instead of 2.0 to 2.1 [#5904 @kit-ty-kate - fix #5816]
+* Remove unused/untested Makefile targets lib-pkg [#5494 @kit-ty-kate]
+* Upgrade vendored packages (cmdliner 1.3.0, ocaml 4.14.2) [#5970 #5976 @kit-ty-kate]
+* Various fixes for Windows:
+  * Fix download URLs containing invalid characters on Windows (e.g. the ? character in `?full_index=1`) [#5921 @dra27]
+  * Harden the CRLF stripping when using cygcheck [#5993 @dra27]
+  * Fix extraction of tarballs on Windows which contain symlinks both when those symlinks can't be created or if they point to files which don't exist [#5953 @dra27]
+  * Fix curl failures - the progress meter can become interleaved with the status code on Windows [#5984 @dra27 @kit-ty-kate @rjbou]
+  * stop hiding the Windows specific arguments of opam init on non-Windows platforms [#6003 @rjbou @kit-ty-kate]
+  * Improve the Git-for-Windows menu shown during opam init [#5963 @dra27 - fix #5835]
+  * For the `Cygwin` internal operator, don't allow `make.exe` to become shadowed [#5996 @dra27]
+  * Fix incorrect quoting rule for `MANPATH` [#5972 @dra27]
+  * Do not special case the rewriting rule for the PKG_CONFIG_PATH environment variable [#6002 @kit-ty-kate - fix #5923]
+  * Pass --symlink-type native to Cygwin setup if symlinks are available [#5830 @dra27]
+  * Pass --no-version-check to Cygwin setup (suppresses a message box if setup needs updating) [#5830 @dra27]
+  * Pass --quiet-mode noinput to stop the user interrupting the setup GUI [#5830 @dra27]
+  * Always pass --no-write-registry to the Cygwin installer, not just on first installation [#5995 @dra27]
+* Various other fixes:
+  * Fix rounding error when displaying the timestamp in debug mode [#5912 @kit-ty-kate - fix #5910]
+  * Relaxed warning 41 in opam lint to not trigger on uses of package variables which are guarded by a package:installed filter [#5927 @dra27]
+  * Move last-env `OPAM_LAST_ENV` files outside the switch to be in `$OPAMROOT` [#5962 @moyodiallo - fix #5823]
+  * Fix a typo in the variable description returned by "opam var" [#5961 @jmid]
+  * (*) Display lock hold/release messages on stderr instead of stdout [#5999 @kit-ty-kate - fix #5990]
+  * Allow to parse opam 2.1 switch import files containing extra-files [#5943 @kit-ty-kate - fix #5941]
+  * Fix `opam tree --with-*` assigning the `with-*` variables to unrequested packages [#5919 @kit-ty-kate @rjbou - fix #5755]
+  * Fix combinations of `opam tree --with-*` and `--no-switch` [#5919 @kit-ty-kate @rjbou - fix #5920]
+  * Stop triggering "Undefined filter variable variable" debug warning for `?variable` [#5983 @dra27]
+* Upgrade the opam-root-version to 2.2~beta [#5904 @kit-ty-kate]
+* Improve and extend the tests [#5919 #5919 #5904 #5925 #5935 #5926 #5935 #5927 @rjbou @dra27]
+* Improve the benchmarks [#5909 @kit-ty-kate]
+* Improve the test infrastructure [#5935 #5938 #5998 @dra27]
+* API changes:
+  * `OpamClient.init` and `OpamClient.reinit`: now can have additional cygwin packages to install [#5930 @moyodiallo]
+  * Expose `OpamSolution.print_depext_msg` [#5994 @dra27]
+  * Extracted `OpamSolution.install_sys_packages` from `OpamSolution.install_depexts` [#5994 @dra27]
+  * `OpamDownload.download_command`: separate output from stdout and stderr [#5984 @kit-ty-kate]
+  * `OpamPath`: remove `OpamPath.Switch.last_env` function in favor to `OpamPath.last_env` as the files are no more stored in switch directory [#5962 @moyodiallo - fix #5823]
+  * `OpamFilter.map_up`: correct handling of FDefined [#5983 @dra27]
+  * `OpamFilter.fold_down_left`: correct handling of FDefined and FUndef [#5983 @dra27]
+  * `OpamStd.String`: add `split_quoted` that preserves quoted separator [#5935 @dra27]
+  * `OpamSystem.copy_dir` and `OpamSystem.mv` may display a warning on Windows if an invalid symlink (e.g. an LXSS Junction) is found [#5953 @dra27]
+  * `OpamStubs.getVersionInfo`: on Windows, retrives the version information block of an executable/library [#5963 @dra27]
+  * `OpamStubs.readRegistry`: on Windows, complements `OpamStubs.writeRegistry` [#5963 @dra27]
+  * `OpamStubs.get_initial_environment`: on Windows, returns the pristine environment for new shells [#5963 @dra27]
+  * `OpamConsole`: Add `formatted_errmsg` [#5999 @kit-ty-kate]
+  * `OpamConsole.menu` now supports up to 35 menu items [#5992 @dra27]
+  * `OpamStd.Sys.resolve_command`: extracted the logic from `OpamSystem.resolve_command`, without the default environment handling from OpamProcess. [#5991 @dra27]
+  * `OpamStd.Sys.resolve_in_path`: split the logic of `OpamStd.Sys.resolve_command` to allow searching for an arbitrary file in the search path [#5991 @dra27]
+  * `OpamProcess.run_background`: name the stderr output file have the .err extension when cmd_stdout is given [#5984 @kit-ty-kate]
+
 2.2.0~beta2:
 * Changes necessary to be able to open the PR adding support for Windows in
   opam-repository:

configure

@@ -1,5 +1,5 @@
 dnl The line below must be formatted AC_INIT([opam],[VERSION]) with no extra spaces
-AC_INIT([opam],[2.2.0~beta3~dev])
+AC_INIT([opam],[2.2.0~beta3])
 AC_COPYRIGHT(Copyright 2012-2019 OcamlPro SAS)
 
 AC_CONFIG_MACRO_DIR([m4])

configure.ac

@@ -11,38 +11,24 @@ moved, etc.), please update the _API updates_ part (it helps opam library
 users)
 
 ## Version
-  * Bump version to 2.2.0~beta3~dev [#5917 @kit-ty-kate]
-  * Bump the version number after the release of 2.2.0~beta1 [#5785 @kit-ty-kate]
-  * Upgrade the opam-root-version to 2.2~beta [#5904 @kit-ty-kate]
 
 ## Global CLI
-  * Fix a typo in the variable description returned by "opam var" [#5961 @jmid]
-  * Out-of-the-box UTF-8 paged --help on Windows [#5970 @kit-ty-kate]
-  * ✘ Display lock hold/release messages on stderr instead of stdout [#5999 @kit-ty-kate - fix #5990]
-  * stop hiding the Windows specific arguments of opam init on non-Windows platforms [#6003 @rjbou @kit-ty-kate]
 
 ## Plugins
 
 ## Init
-  * ◈ New option `opam init --cygwin-extra-packages=CYGWIN_PKGS --cygwin-internal-install`, to specify additional packages for internal Cygwin [#5930, #5964 @moyodiallo - fix #5834]
-  * Skip Git-for-Windows menu if the Git binary resolved in PATH is Git-for-Windows [#5963 @dra27 - fix #5835]
-  * Enhance the Git menu by warning if the user appears to need to restart the shell to pick up PATH changes [#5963 @dra27]
-  * Include Git for Windows installations in the list of possibilities where the user instructed Git-for-Windows setup not to update PATH [#5963 @dra27]
 
 ## Config report
 
 ## Actions
 
 ## Install
-  * Fix performance regression when calling opam install --deps-only on an already installed package [#5908 @kit-ty-kate - fix #5817]
 
 ## Remove
 
 ## Switch
-  * Allow to parse opam 2.1 switch import files containing extra-files [#5943 @kit-ty-kate - fix #5941]
 
 ## Config
-  * Move last-env `OPAM_LAST_ENV` files outside the switch to be in the `opam root` [#5962 @moyodiallo - fix #5823]
 
 ## Pin
 
@@ -53,66 +39,38 @@ users)
 ## Var/Option
 
 ## Update / Upgrade
-  * [BUG] Stop triggering "Undefined filter variable variable" warning for `?variable` [#5983 @dra27]
 
 ## Tree
-  * [BUG] Fix `opam tree --with-*` assigning the `with-*` variables to unrequested packages [#5919 @kit-ty-kate @rjbou - fix #5755]
-  * [BUG] Fix combinations of `opam tree --with-*` and `--no-switch` [#5919 @kit-ty-kate @rjbou - fix #5920]
 
 ## Exec
 
 ## Source
-  * Fix extraction of tarballs on Windows which contain symlinks both when those symlinks can't be created or if they point to files which don't exist [#5953 @dra27]
 
 ## Lint
-  * W41: Relax warning 41 not to trigger on uses of package variables which are guarded by a package:installed filter [#5927 @dra27]
-  * W41: Tighten w.r.t depends & depopts [#5927 @dra27]
 
 ## Repository
-  * Fix download URLs containing invalid characters on Windows (e.g. the ? character in `?full_index=1`) [#5921 @dra27]
-  * [BUG] Fix curl failures - the progress meter can become interleaved with the status code on Windows [#5984 @dra27 @kit-ty-kate @rjbou]
 
 ## Lock
 
 ## Clean
 
 ## Env
-  * [BUG] Fix reverting of environment variables, principally on Windows [#5935 @dra27 fix #5838]
-  * [BUG] Fix splitting environment variables [#5935 @dra27]
-  * [BUG] When opam creates an empty variable then appends/prepends a value, ensure no additional separator is added [#5935 @dra27 - fix #5925]
-  * [BUG] Fix `x-env-path-rewrite` splitting of values when reverting [#5935 @dra27 - fix #5838]
-  * [BUG] Rework the logic of := and =: so that an empty entry is correctly preserved on multiple updates [#5935 @dra27 - fix #5926]
-  * [BUG] Fix incorrect reverting of `=+` and `=:` [#5935 @dra27 - fix #5926]
-  * For the `Cygwin` internal operator, don't allow `make.exe` to become shadowed [#5996 @dra27]
-  * [BUG] Fix incorrect quoting rule for `PKG_CONFIG_PATH` [#5972 @dra27 - partial fix for #5923]
-  * [BUG] Do not special case the rewriting rule for the PKG_CONFIG_PATH environment variable [#6002 @kit-ty-kate - fix #5923]
 
 ## Opamfile
 
 ## External dependencies
-  * Pass --symlink-type native to Cygwin setup if symlinks are available [#5830 @dra27]
-  * Pass --no-version-check to Cygwin setup (suppresses a message box if setup needs updating) [#5830 @dra27]
-  * Pass --quiet-mode noinput to stop the user interrupting the setup GUI [#5830 @dra27]
-  * Always pass --no-write-registry to the Cygwin installer, not just on first installation [#5995 @dra27]
 
 ## Format upgrade
-  * Handle init OCaml `sys-ocaml-*` eval variables during format upgrade from 2.0 -> 2.1 -> 2.2 [#5829 @dra27]
-  * Reset the "jobs" config variable when upgrading from opam 2.1 to 2.2, instead of 2.0 to 2.1 [#5904 @kit-ty-kate - fix #5816]
 
 ## Sandbox
+
 ## VCS
 
 ## Build
-  * Upgrade vendored cmdliner to 1.3.0 [#5970 @kit-ty-kate]
-  * Remove unused/untested Makefile targets lib-pkg [#5494 @kit-ty-kate]
-  * Upgrade vendored OCaml compiler to 4.14.2 [#5976 @kit-ty-kate]
 
 ## Infrastructure
-  * Ensure GNU coreutils available on the macOS 14 CI runners [#5938 @dra27]
-  * Update the opam-repository testing sha to include the new compiler packages in opam-repository [#5998 @dra27]
 
 ## Release scripts
-  * Upgrade the OCaml compiler used for releases to 4.14.2 [#5976 @kit-ty-kate]
 
 ## Install script
 
@@ -127,37 +85,21 @@ users)
 ## Solver
 
 ## Client
-  * Fix rounding error when displaying the timestamp in debug mode [#5912 @kit-ty-kate - fix #5910]
 
 ## Shell
 
 ## Internal
-  * Noisy code refactor renaming `OpamClient.git_for_windows_check` to `OpamClient.git_for_windows` [#5997 @dra27]
 
 ## Internal: Windows
-  * Set the console to use UTF-8 on Windows using SetConsoleCP and SetConsoleOutputCP [#5970 @kit-ty-kate]
-  * Harden the CRLF stripping when using cygcheck [#5993 @dra27]
 
 ## Test
 
 ## Benchmarks
-  * Benchmark opam install --deps-only of an already installed package [#5909 @kit-ty-kate]
 
 ## Reftests
 ### Tests
-  * tree: add a test for packages that have variables in their transitive dependencies [#5919 @rjbou]
-  * tree: add test for `opam tree pkg --with-test --no-switch` [#5919 @rjbou]
-  * Update opam root version test with root version bump [#5904 @rjbou]
-  * env tests: use `sort` to increase stability of the `opam env` output [#5935 @dra27 @rjbou]
-  * env.win32: add mixed slashes test [#5935 @dra27]
-  * env.win32: add test for environment revert not working correctly for Unix-like variables on Windows [#5935 @dra27]
-  * env.win32: add regression test for reverting additions to PATH-like variables [#5935 @dra27]
-  * env tests: add regression test for append/prepend operators to empty environment variables [#5925, #5935 @dra27]
-  * env.win32: add regression test for handling the empty entry in PATH-like variables [#5926, #5935 @dra27]
-  * lint: add W41 examples [#5927 @dra27]
 
 ### Engine
-  * Add `sort` command [#5935 @dra27]
 
 ## Github Actions
 
@@ -167,30 +109,13 @@ users)
 
 # API updates
 ## opam-client
-  * `OpamClient.init` and `OpamClient.reinit`: now can have additional cygwin packages to install [#5930 @moyodiallo]
-  * Expose `OpamSolution.print_depext_msg` [#5994 @dra27]
-  * Extracted `OpamSolution.install_sys_packages` from `OpamSolution.install_depexts` [#5994 @dra27]
 
 ## opam-repository
-  * `OpamDownload.download_command`: separate output from stdout and stderr [#5984 @kit-ty-kate]
 
 ## opam-state
 
 ## opam-solver
 
 ## opam-format
-  * `OpamPath`: remove `OpamPath.Switch.last_env` function in favor to `OpamPath.last_env` as the files are no more stored in switch directory [#5962 @moyodiallo - fix #5823]
-  * `OpamFilter.map_up`: correct handling of FDefined [#5983 @dra27]
-  * `OpamFilter.fold_down_left`: correct handling of FDefined and FUndef [#5983 @dra27]
 
 ## opam-core
-  * `OpamStd.String`: add `split_quoted` that preserves quoted separator [#5935 @dra27]
-  * `OpamSystem.copy_dir` and `OpamSystem.mv` may display a warning on Windows if an invalid symlink (e.g. an LXSS Junction) is found [#5953 @dra27]
-  * `OpamStubs.getVersionInfo`: on Windows, retrives the version information block of an executable/library [#5963 @dra27]
-  * `OpamStubs.readRegistry`: on Windows, complements `OpamStubs.writeRegistry` [#5963 @dra27]
-  * `OpamStubs.get_initial_environment`: on Windows, returns the pristine environment for new shells [#5963 @dra27]
-  * `OpamConsole`: Add `formatted_errmsg` [#5999 @kit-ty-kate]
-  * `OpamConsole.menu` now supports up to 35 menu items [#5992 @dra27]
-  * `OpamStd.Sys.resolve_command`: extracted the logic from `OpamSystem.resolve_command`, without the default environment handling from OpamProcess. [#5991 @dra27]
-  * `OpamStd.Sys.resolve_in_path`: split the logic of `OpamStd.Sys.resolve_command` to allow searching for an arbitrary file in the search path [#5991 @dra27]
-  * `OpamProcess.run_background`: name the stderr output file have the .err extension when cmd_stdout is given [#5984 @kit-ty-kate]

master_changes.md

@@ -1,5 +1,5 @@
 opam-version: "2.0"
-version: "2.2.0~beta3~dev"
+version: "2.2.0~beta3"
 synopsis: "Client library for opam 2.2"
 description: """
 Actions on the opam root, switches, installations, and front-end.

opam-client.opam

@@ -1,5 +1,5 @@
 opam-version: "2.0"
-version: "2.2.0~beta3~dev"
+version: "2.2.0~beta3"
 synopsis: "Core library for opam 2.2"
 description: """
 Small standard library extensions, and generic system interaction modules used by opam.

opam-core.opam

@@ -1,5 +1,5 @@
 opam-version: "2.0"
-version: "2.2.0~beta3~dev"
+version: "2.2.0~beta3"
 synopsis: "Bootstrapped development binary for opam 2.2"
 description: """
 This package compiles (bootstraps) opam. For consistency and safety of the installation, the binaries are not installed into the PATH, but into lib/opam-devel, from where the user can manually install them system-wide.

opam-devel.opam

@@ -1,5 +1,5 @@
 opam-version: "2.0"
-version: "2.2.0~beta3~dev"
+version: "2.2.0~beta3"
 synopsis: "Format library for opam 2.2"
 description: """
 Definition of opam datastructures and its file interface.

opam-format.opam

@@ -1,5 +1,5 @@
 opam-version: "2.0"
-version: "2.2.0~beta3~dev"
+version: "2.2.0~beta3"
 synopsis: "Installation of files to a prefix, following opam conventions"
 description: """
 opam-installer is a small tool that can read *.install files, as defined by opam [1], and execute them to install or remove package files without going through opam.

opam-installer.opam

@@ -1,5 +1,5 @@
 opam-version: "2.0"
-version: "2.2.0~beta3~dev"
+version: "2.2.0~beta3"
 synopsis: "Repository library for opam 2.2"
 description: """
 This library includes repository and remote sources handling, including curl/wget, rsync, git, mercurial, darcs backends.

opam-repository.opam

@@ -1,5 +1,5 @@
 opam-version: "2.0"
-version: "2.2.0~beta3~dev"
+version: "2.2.0~beta3"
 synopsis: "Solver library for opam 2.2"
 description: """
 Solver and Cudf interaction. This library is based on the Cudf and Dose libraries, and handles calls to the external solver from opam.

opam-solver.opam

@@ -1,5 +1,5 @@
 opam-version: "2.0"
-version: "2.2.0~beta3~dev"
+version: "2.2.0~beta3"
 synopsis: "State library for opam 2.2"
 description: """
 Handling of the ~/.opam hierarchy, repository and switch states.