Update Getting Started instructions with modern shell invocation and OPAM 1.2.2 note #562
Conversation
dra27
changed the title
| @@ -36,27 +36,27 @@ port install opam | |||
|
|
|||
| **For Linux** the preferred way is to use your system's package manager on | |||
| Linux (e.g `apt-get install opam` or similar). [Details of all installation | |||
| methods.](https://opam.ocaml.org/doc/Install.html) | |||
| methods.](https://opam.ocaml.org/doc/Install.html). All supported Linux distributions package at least version 2.0.0 (you can check by running `opam --version`). If you are using an unsupported Linux distribution, please either download a precompiled binary or build opam from sources. | |||
There was a problem hiding this comment.
Should this be in the "For Linux" category? My gut feeling is that the main source of severely outdated opam would be a virtual image of an old system, can't MacOS + brew have the same issue?
(Reading this section again, my impression is that the "For macOS / For Linux" split could be part of its own subsection "Install opam" before "Install OCaml", and that this subsection would be the right place to have this warning.)
There was a problem hiding this comment.
I don't think it applies to macOS. On an out-of-date Debian, assuming apt-get update works at all out of the box of the box (eventually the repos get moved to archives), you will get OPAM 1.2.2 because it uses an old repository to go with the old distro. On macOS you get the same repository whichever version of macOS you're running and, even if for some reason opam 2.x wouldn't install, brew and macports only carry one version of a package, so you'd either get the latest version of opam regardless or an error trying to install it.
|
Note: @dra27 while you are at it, it might be that the Windows part of this page would benefit from a refresh as well: it links to the fdopen repository, which itself includes a large banner that it is discontinued, this could be worrying for users. Maybe for now removing the "if you need Windows binaries" paragraph would be the safer choice. (I guess this is a separate issue / separate PR, but you are a great person to talk to about it.) |
|
(Regarding Windows, the Diskuv installer may deserve a mention, but it may be a bit experimental still -- as everything on Windows I guess.) |
|
This isn't precisely the time/place to sort out the Windows part! I'm presently doing quite a good "cat typing at the keyboard" act, and the Windows OCaml packages are part of that (being tied in with both opam 2.2 and relocatable compiler). See also #554 |
tmattio
force-pushed
the
ancient-opam
branch
from
46b4bc4
to
e402d96
Compare
|
Thanks @dra27! We had rewritten a large part of the Up and Running tutorial to make it more accessible to beginners, and it seems that your first commit had been addressed while doing so. I've just merged the new version in #565 and rebased your PR on top of it. Let me know if the new diff looks good to you and I can merge the PR 🙂 |
|
Even better, yes! |
cf. ocaml/ocaml#11532.
eval $(opam env)- the website's styling for code (which adds backticks) made the text extremely confusing!