windows: opam root redirection when path contains spaces #5457

rjbou · 2023-02-28T13:34:13Z

On Windows, opam may install a local cygwin, but cygwin doesn't support having a space in its path. We need then to redirect all opam root into a path with no space. Redirection is done at first init, and afterwards it is followed for each opam call.
So opam root directory can contain either:

an unique file redirected-opamroot that contains the new path
or the already known opam root.
update changes
update message with relevant root dir
set default path, or give user the choice
add an error if --root/OPAMROOT path contains space
add readme.txt in C:\opamroot

related to #5220

kit-ty-kate · 2024-05-23T09:44:40Z

note from dev meeting: for the directory we could create a new directory in C:\, it should be possible to create one without admin priviledges

src/client/opamClient.ml

kit-ty-kate

General question: why do we redirect the entire opam root instead of just installing Cygwin in C:\opam-cygwin or similar? What are the advantage/inconvenient of both solutions?

src/client/opamClient.ml

src/client/opamClientConfig.ml

kit-ty-kate · 2024-06-04T18:04:06Z

tests/reftests/env.test

-> installed nv.1
-Done.
-# Run eval $(opam env '--root=${BASEDIR}/root 2' '--switch=${BASEDIR}/switch w spaces') to update the current shell environment
-### opam env --root "$RT" --switch "./$SW" | grep "NV_VARS" | ';' -> ':'


why is this test not needed anymore? What was it testing to being with?

It is moved to env.unix & init.win32 as the behaviour differs

I'm not seeing that command in either of those files

ah,the command itself, true.

I think that originally it was here to show that the switch was well created?

The new one doesn't seem to do the same thing grep NV_VARS vs grep PREFIX. The original line was added by #5476 which seems to have another purpose. cc @dra27

This is safe - the main thing is that the primary tests in #5935 (further up the file) are still there. The noise in these other parts suggests that the tests should possibly be split up a bit further (but's definitely a post 2.2.0 thing!)

src/client/opamClientConfig.ml

src/client/opamClient.ml

kit-ty-kate · 2024-06-05T18:05:59Z

General question: why do we redirect the entire opam root instead of just installing Cygwin in C:\opam-cygwin or similar? What are the advantage/inconvenient of both solutions?

my question wasn't answered. Looks fine otherwise on a glance, i'll test it tomorrow

rjbou · 2024-06-06T09:02:27Z

I know, i hadn't time :)
The main point, if I remember well, is to keep everything under the opam root. Besides, users are used to delete opam root to restart from scratch. If internal cygwin is a separated directory, it can lead to partial install left in that case.
I agree that on purely technical part, it'll be easier (and less changes) if we store only the Cygwin install under C:.
@dra27 Do you remember another point we discussed at the time ?

dra27 · 2024-06-09T09:57:24Z

tests/reftests/init.win32.test

+->  test              test
+### echo $OPAMROOT
+roots/with path
+### rm -rf 'C:\opamroot'


This definitely can't stay - it blows away the user's opam root!

but then the tests are not reproducible on Windows at all

It's ok for CI, on tester computer, we can add a note about it in the test and not remove something outside the test directories

kit-ty-kate · 2024-06-10T10:27:43Z

The tests have been split off to #6006

Used to indicate opam root redirection

src/client/opamClient.ml

It is needed for Cygwin installation, that doesn't handle paths with space. At init, detection and redirection are done, afterwards opam always load redirected opam root. Original root directory is stored in `OpamStateConfig.!r.original_root_dir`. Co-authored-by: David Allsopp <david.allsopp@metastack.com>

rjbou · 2024-06-10T13:44:20Z

🎉

rjbou · 2024-06-10T14:35:55Z

Thanks all!

rjbou added AREA: PORTABILITY PR: WIP Not for merge at this stage labels Feb 28, 2023

rjbou added this to the 2.2.0~alpha milestone Feb 28, 2023

rjbou requested a review from dra27 February 28, 2023 13:34

rjbou added this to PR in progress in Opam 2.2.0 via automation Feb 28, 2023

rjbou moved this from PR in progress to PR to review for 2.2.0~alpha in Opam 2.2.0 Feb 28, 2023

rjbou moved this from PR to review for 2.2.0~alpha to PR to review in Opam 2.2.0 Mar 14, 2023

rjbou moved this from PR to review to After ~alpha; before release in Opam 2.2.0 May 11, 2023

rjbou removed this from the 2.2.0~alpha milestone Jun 7, 2023

rjbou moved this from After ~alpha; before release to For RC in Opam 2.2.0 Jul 31, 2023

rjbou force-pushed the opamroot-redirect branch from 9484393 to 887acca Compare April 9, 2024 18:28

rjbou added the PR: WAITING FOR REVIEW label Apr 10, 2024

rjbou self-assigned this May 27, 2024

kit-ty-kate moved this from For RC to For beta3 in Opam 2.2.0 May 27, 2024

rjbou removed the PR: WIP Not for merge at this stage label Jun 3, 2024

rjbou force-pushed the opamroot-redirect branch from 887acca to 33b6306 Compare June 3, 2024 17:33

kit-ty-kate self-requested a review June 4, 2024 12:26

rjbou commented Jun 4, 2024

View reviewed changes

src/client/opamClient.ml Outdated Show resolved Hide resolved

kit-ty-kate reviewed Jun 4, 2024

View reviewed changes

rjbou commented Jun 5, 2024

View reviewed changes

src/client/opamClientConfig.ml Outdated Show resolved Hide resolved

rjbou requested a review from kit-ty-kate June 5, 2024 17:55

kit-ty-kate reviewed Jun 5, 2024

View reviewed changes

src/client/opamClient.ml Outdated Show resolved Hide resolved

kit-ty-kate force-pushed the opamroot-redirect branch 5 times, most recently from 94ef0e4 to 1883aac Compare June 7, 2024 18:14

kit-ty-kate mentioned this pull request Jun 7, 2024

Release 2.2.0~beta3 #6004

Merged

3 tasks

dra27 reviewed Jun 9, 2024

View reviewed changes

dra27 added this to the 2.2.0~beta3 milestone Jun 9, 2024

kit-ty-kate mentioned this pull request Jun 10, 2024

reftest: add a test showing root redirection on Windows when OPAMROOT contains spaces #6006

Draft

kit-ty-kate force-pushed the opamroot-redirect branch from 1883aac to 6730dea Compare June 10, 2024 10:27

rjbou and others added 4 commits June 10, 2024 13:13

path: add redirected

7dd7f8d

Used to indicate opam root redirection

stateConfig: add original_root_dir to store non redirected root dir

da4368b

Add provenance of opam root, as for current switch

7bd96b7

console: add collision utf-8 symbol

d308529

rjbou force-pushed the opamroot-redirect branch from 6730dea to ddc6389 Compare June 10, 2024 11:31

kit-ty-kate reviewed Jun 10, 2024

View reviewed changes

src/client/opamClient.ml Show resolved Hide resolved

kit-ty-kate reviewed Jun 10, 2024

View reviewed changes

src/client/opamClient.ml Show resolved Hide resolved

dra27 and others added 2 commits June 10, 2024 15:29

system: add mk_unique_dir

01ed890

rjbou force-pushed the opamroot-redirect branch from ddc6389 to c43f7b4 Compare June 10, 2024 13:29

kit-ty-kate approved these changes Jun 10, 2024

View reviewed changes

kit-ty-kate added STATE: READY TO MERGE and removed PR: WAITING FOR REVIEW labels Jun 10, 2024

rjbou merged commit a879424 into ocaml:master Jun 10, 2024
29 checks passed

Opam 2.2.0 automation moved this from For beta3 to Done Jun 10, 2024

dra27 mentioned this pull request Jun 13, 2024

Does OPAM work on windows? #246

Closed

This was referenced Jun 21, 2024

CI checks for API users #6044

Open

Restore signature of OpamStateConfig.opamroot #6047

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

windows: opam root redirection when path contains spaces #5457

windows: opam root redirection when path contains spaces #5457

rjbou commented Feb 28, 2023 •

edited by kit-ty-kate

Loading

kit-ty-kate commented May 23, 2024

kit-ty-kate left a comment

kit-ty-kate Jun 4, 2024

rjbou Jun 5, 2024

kit-ty-kate Jun 5, 2024

rjbou Jun 5, 2024

rjbou Jun 5, 2024

rjbou Jun 5, 2024

kit-ty-kate Jun 5, 2024

dra27 Jun 8, 2024

kit-ty-kate commented Jun 5, 2024

rjbou commented Jun 6, 2024 •

edited

Loading

dra27 Jun 9, 2024

kit-ty-kate Jun 10, 2024

rjbou Jun 10, 2024

kit-ty-kate commented Jun 10, 2024 •

edited

Loading

rjbou commented Jun 10, 2024

rjbou commented Jun 10, 2024

windows: opam root redirection when path contains spaces #5457

windows: opam root redirection when path contains spaces #5457

Conversation

rjbou commented Feb 28, 2023 • edited by kit-ty-kate Loading

kit-ty-kate commented May 23, 2024

kit-ty-kate left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kit-ty-kate commented Jun 5, 2024

rjbou commented Jun 6, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kit-ty-kate commented Jun 10, 2024 • edited Loading

rjbou commented Jun 10, 2024

rjbou commented Jun 10, 2024

rjbou commented Feb 28, 2023 •

edited by kit-ty-kate

Loading

rjbou commented Jun 6, 2024 •

edited

Loading

kit-ty-kate commented Jun 10, 2024 •

edited

Loading