Update ocaml on Windows: add opam 2.2 #2727

RadioPotin · 2024-09-27T13:44:38Z

Greetings,

@rjbou and myself have updated OCaml on Windows tutorial to add opam workflows as the recommended one for installing OCaml on Windows.

Best regards,

Co-authored-by: Raja Boujbel <[email protected]>

cuihtlauac · 2024-09-27T14:14:41Z

Beautiful! Thank you very much, @RadioPotin and @rjbou, this is awesome.
@Sudha247, @dra27, @jonahbeckford: any views on this?

Sudha247

Wonderful, this reads very nicely! Huge +1 from my side. Some minor comments below.

Sudha247 · 2024-10-01T06:01:37Z

data/tutorials/getting-started/3_01_ocaml_on_windows.md

+One detail to address about having a fully functional opam installation is
+related to Git.
+
+On Windows, there are many ways to have a functioning Git installation. Opam will


Isn't it recommended to obtain git via winget, too?

It is indeed. This sentence purpose is to introduce the Git opam init section.

Sudha247 · 2024-10-01T06:10:21Z

data/tutorials/getting-started/3_01_ocaml_on_windows.md

@@ -92,6 +286,8 @@ easier way to get a working Windows environment on your machine.

 ### Visual Studio Code on Windows

+**If you use opam installation**, you will need to add opam switch prefix on your path that runs VSCode.


Perhaps there could be a link here on how to add switch prefix to the path?

Why is that needed at all? If it is needed, we should file a bug somewhere since that is quite unpleasant for a user.

data/tutorials/getting-started/3_01_ocaml_on_windows.md

jonahbeckford · 2024-10-01T06:33:57Z

data/tutorials/getting-started/3_01_ocaml_on_windows.md

-installer that we recommend for new users. However, while [DkML] has a modern OCaml 4.14.0 compiler,
+## opam
+
+Opam now features a fully native Windows compatible installation process that we


I get the sentiment, but it isn't accurate to describe a Cygwin installation process as a fully native Windows compatible installation process. IMHO the real win is how easy it is to install Windows with opam 2.2 ... very few questions asked, no prereqs other than Git, etc. ... and the ease of install could be a good lead sentence.

data/tutorials/getting-started/3_01_ocaml_on_windows.md

jonahbeckford · 2024-10-01T07:09:02Z

data/tutorials/getting-started/3_01_ocaml_on_windows.md

+fully functional OCaml compiler available to you:
+
+```shell-session
+> for /f "tokens=*" %i in ('opam env --switch=default') do @%i


Correct me if I'm wrong, but if you install winget in a terminal, and then install opam using winget, any subsequent opam like opam env will fail with Not Found, right? Because opam won't be in the PATH. If so, I think we need to insert a step to close and reopen the terminal.

True, this is specified at the beginning:

Once the package is installed, you can launch a new shell to have access to
your fresh opam binary.

Here, it is have access to OCaml after opam init, so we already have a terminal that have an opam binary in the path.

tmattio · 2024-10-01T07:10:27Z

data/tutorials/getting-started/3_01_ocaml_on_windows.md

-supporting an external dependency installation for Windows and integrating it with the
-Windows shell. From an `opam-repository` perspective, the `ocaml-base-compiler`
-packages will support the MinGW-w64 and MSVC variants.
-
 ## Installation Environments

 ### `opam-repository-mingw`


I think we can remove this section entirely since it is deprecated and opam-repository is now compatible with Windows.

rjbou

Thanks all for the reviews! I've addressed some in comments.

data/tutorials/getting-started/3_01_ocaml_on_windows.md

rjbou · 2024-10-02T16:14:00Z

data/tutorials/getting-started/3_01_ocaml_on_windows.md

+One detail to address about having a fully functional opam installation is
+related to Git.
+
+On Windows, there are many ways to have a functioning Git installation. Opam will


It is indeed. This sentence purpose is to introduce the Git opam init section.

rjbou · 2024-10-02T16:16:13Z

data/tutorials/getting-started/3_01_ocaml_on_windows.md

+fully functional OCaml compiler available to you:
+
+```shell-session
+> for /f "tokens=*" %i in ('opam env --switch=default') do @%i


True, this is specified at the beginning:

Once the package is installed, you can launch a new shell to have access to
your fresh opam binary.

Here, it is have access to OCaml after opam init, so we already have a terminal that have an opam binary in the path.

Co-authored-by: R. Boujbel <[email protected]>

RadioPotin · 2024-10-03T11:51:34Z

Hey again everybody,

Thank you ever so much for the constructive suggestions, hopefully this version is now mergeable,

Kind regards,

qrpnxz

A couple of details still make reference to a future release of opam 2.2.
Installation of git at the same time as opam should be suggested.

qrpnxz · 2024-10-03T13:15:14Z

data/tutorials/getting-started/3_01_ocaml_on_windows.md

 it does not track the latest OCaml compilers. We will officially support Windows as a Tier 1
 platform with a [major release of opam](#opam-22) in the coming months, and it will be compatible with


We will officially support Windows as a Tier 1 platform with a [major release of opam](#opam-22) in the coming months,

Already happened, hence this PR. This link will be broken.

qrpnxz · 2024-10-03T13:16:45Z

data/tutorials/getting-started/3_01_ocaml_on_windows.md

@@ -38,21 +239,12 @@ The guidance is based on the availability table below:
 ╰──────────────────────────────────────────────────────────────────────────────────────────╯


│ Tier 1 │ OCaml 5 with Opam 2.2 │ Full support. Coming in the next few months │

Already happened.

qrpnxz · 2024-10-03T13:18:56Z

data/tutorials/getting-started/3_01_ocaml_on_windows.md

+Cygwin Git is functional but can have credentials issues for private repositories, we recommend using:
+  - Install via 'winget install Git.Git'


This would be good to know from the outset. https://ocaml.org/install#windows recommends doing

winget install Git.Git OCaml.opam

Add opam for Windows installation tutorial

e7431f5

Co-authored-by: Raja Boujbel <[email protected]>

RadioPotin requested a review from christinerose as a code owner September 27, 2024 13:44

Sudha247 reviewed Oct 1, 2024

View reviewed changes

jonahbeckford reviewed Oct 1, 2024

View reviewed changes

data/tutorials/getting-started/3_01_ocaml_on_windows.md Outdated Show resolved Hide resolved

jonahbeckford reviewed Oct 1, 2024

View reviewed changes

data/tutorials/getting-started/3_01_ocaml_on_windows.md Outdated Show resolved Hide resolved

jonahbeckford reviewed Oct 1, 2024

View reviewed changes

data/tutorials/getting-started/3_01_ocaml_on_windows.md Show resolved Hide resolved

jonahbeckford reviewed Oct 1, 2024

View reviewed changes

data/tutorials/getting-started/3_01_ocaml_on_windows.md Outdated Show resolved Hide resolved

jonahbeckford reviewed Oct 1, 2024

View reviewed changes

tmattio reviewed Oct 1, 2024

View reviewed changes

Minor line editing / formatting on 3_01_ocaml_on_windows.md

d6c22ae

christinerose approved these changes Oct 2, 2024

View reviewed changes

rjbou reviewed Oct 2, 2024

View reviewed changes

RadioPotin and others added 3 commits October 3, 2024 13:46

edit section mentioning winget

a53338a

Co-authored-by: R. Boujbel <[email protected]>

remove windows file management comment

ba1afbe

Co-authored-by: R. Boujbel <[email protected]>

Change OCaml compiler version to 4.14.2

c75a62c

Co-authored-by: R. Boujbel <[email protected]>

qrpnxz suggested changes Oct 3, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update ocaml on Windows: add opam 2.2 #2727

Update ocaml on Windows: add opam 2.2 #2727

RadioPotin commented Sep 27, 2024

cuihtlauac commented Sep 27, 2024 •

edited

Loading

Sudha247 left a comment

Sudha247 Oct 1, 2024

rjbou Oct 2, 2024

Sudha247 Oct 1, 2024

jonahbeckford Oct 1, 2024

jonahbeckford Oct 1, 2024

jonahbeckford Oct 1, 2024

rjbou Oct 2, 2024

tmattio Oct 1, 2024

rjbou left a comment

rjbou Oct 2, 2024

rjbou Oct 2, 2024

RadioPotin commented Oct 3, 2024

qrpnxz left a comment

qrpnxz Oct 3, 2024

qrpnxz Oct 3, 2024

qrpnxz Oct 3, 2024

		@@ -92,6 +286,8 @@ easier way to get a working Windows environment on your machine.

		### Visual Studio Code on Windows

		If you use opam installation, you will need to add opam switch prefix on your path that runs VSCode.

		it does not track the latest OCaml compilers. We will officially support Windows as a Tier 1
		platform with a [major release of opam](#opam-22) in the coming months, and it will be compatible with

		@@ -38,21 +239,12 @@ The guidance is based on the availability table below:
		╰──────────────────────────────────────────────────────────────────────────────────────────╯

		Cygwin Git is functional but can have credentials issues for private repositories, we recommend using:
		- Install via 'winget install Git.Git'

Update ocaml on Windows: add opam 2.2 #2727

Are you sure you want to change the base?

Update ocaml on Windows: add opam 2.2 #2727

Conversation

RadioPotin commented Sep 27, 2024

cuihtlauac commented Sep 27, 2024 • edited Loading

Sudha247 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

rjbou left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

RadioPotin commented Oct 3, 2024

qrpnxz 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

cuihtlauac commented Sep 27, 2024 •

edited

Loading