summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNicolas Ojeda Bar <n.oje.bar@gmail.com>2022-06-24 15:08:20 +0200
committerGitHub <noreply@github.com>2022-06-24 15:08:20 +0200
commit47fcd6d177a004592c88389d0c9330a866a54fc0 (patch)
tree2d5fb98185f58872a2030a4cfc6c7cfd214b9700
parentbb03e1103d0c1d5474098c7c3da91d1faa95ac06 (diff)
downloadocaml-47fcd6d177a004592c88389d0c9330a866a54fc0.tar.gz
READMEs: add note about 5.0 status (#11355)
-rw-r--r--.gitattributes2
-rw-r--r--README.adoc20
-rw-r--r--README.win32.adoc18
3 files changed, 40 insertions, 0 deletions
diff --git a/.gitattributes b/.gitattributes
index 7bb4730a7f..260cdd1514 100644
--- a/.gitattributes
+++ b/.gitattributes
@@ -58,6 +58,8 @@ tools/mantis2gh_stripped.csv typo.missing-header
/.mailmap typo.long-line typo.missing-header typo.non-ascii
/CONTRIBUTING.md typo.non-ascii=may
+/README.adoc typo.non-ascii=may
+/README.win32.adoc typo.non-ascii=may
/.merlin typo.missing-header
/Changes typo.utf8 typo.missing-header
/release-info/News typo.utf8 typo.missing-header
diff --git a/README.adoc b/README.adoc
index 4da813b9c8..3c361cd8ce 100644
--- a/README.adoc
+++ b/README.adoc
@@ -1,3 +1,23 @@
+=== ⚠️ CAUTION
+
+The developer team is currently preparing the release of OCaml 5.0. This release
+sports a full rewrite of its runtime system for shared-memory parallel
+programming using domains and native support for concurrent programming using
+effect handlers.
+
+Owing to the large number of changes, the initial 5.0 release will be more
+experimental than usual. It is recommended that all users wanting a stable
+release use the 4.14 release which will continue to be supported and updated
+while 5.0 reaches feature and stability parity. Similarly, if you need one of
+the ports not yet supported in the 5.0 release you must use the 4.14 release.
+
+The initial release of OCaml 5.0 will only support the native compiler under
+ARM64 and x86-64 architectures under Linux and macOS. On Windows, only the
+Mingw-w64 port is supported. Support for other 64-bit architectures and systems
+will be added back in later releases. On 32-bit systems, only the bytecode
+compiler is supported. Native-code support for these systems is under
+discussion.
+
|=====
| Branch `trunk` | Branch `4.14` | Branch `4.13` | Branch `4.12`
diff --git a/README.win32.adoc b/README.win32.adoc
index 5c4041ac22..63aec24e46 100644
--- a/README.win32.adoc
+++ b/README.win32.adoc
@@ -1,3 +1,21 @@
+=== ⚠️ CAUTION
+
+The developer team is currently preparing the release of OCaml 5.0. This release
+sports a full rewrite of its runtime system for shared-memory parallel
+programming using domains and native support for concurrent programming using
+effect handlers.
+
+Owing to the large number of changes, the initial 5.0 release will be more
+experimental than usual. It is recommended that all users wanting a stable
+release use the 4.14 release which will continue to be supported and updated
+while 5.0 reaches feature and stability parity. Similarly, if you need one of
+the ports not yet supported in the 5.0 release you must use the 4.14 release.
+
+Only the Mingw-w64 port is supported. On 32-bit systems, only the bytecode
+compiler is supported. Native-code support for these 32-bit systems is under
+discussion. Support for the MSVC and Cygwin ports will be added back in later
+releases.
+
= Release notes for the Microsoft Windows ports of OCaml =
:toc: macro