From 4824f5ad4088eb05854a90cafe1613b25a47b22b Mon Sep 17 00:00:00 2001 From: Arvid Jakobsson Date: Fri, 1 Nov 2024 09:55:29 +0100 Subject: [PATCH 1/9] Remove outdated contributing docs, on [appveyor] and [travis] Also removed [style.css] which does not seem to be used anywhere. --- docs/CONTRIBUTING.md | 15 +-- src/util/appveyor-build.sh | 27 ------ src/util/appveyor-install.sh | 24 ----- src/util/style.css | 171 ----------------------------------- src/util/travis-docs.sh | 66 -------------- 5 files changed, 4 insertions(+), 299 deletions(-) delete mode 100644 src/util/appveyor-build.sh delete mode 100644 src/util/appveyor-install.sh delete mode 100644 src/util/style.css delete mode 100644 src/util/travis-docs.sh diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 7e9478829b..c09acb6372 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -81,8 +81,6 @@ eval `opam config env` # optional make dev-deps ``` -[opam-depends]: https://github.com/ocsigen/lwt/blob/8bff603ae6d976e69698fa08e8ce08fe9615489d/opam/opam#L35-L44 - On most systems, you should also [install libev][installing]: ``` @@ -158,8 +156,8 @@ Go to the GitHub web interface for your Lwt fork button. Follow the instructions, and open the pull request. This will trigger automatic building and testing of your change on many versions -of OCaml, and several operating systems, in [Travis][travis-ci] and -[AppVeyor][appveyor-ci]. You can even a submit a preliminary PR just to trigger +of OCaml, and several operating systems, in [GitHub Actions][github-actions]. +You can even a submit a preliminary PR just to trigger these tests – just say in the description that it's not ready for review! At about the same time, a (hopefully!) friendly maintainer will review your @@ -201,8 +199,7 @@ If we do this rewriting, it is usually at the very end, right before merging the PR. This is to avoid interfering with reviewers while they are still reviewing it. -[travis-ci]: https://travis-ci.org/ocsigen/lwt -[appveyor-ci]: https://ci.appveyor.com/project/aantron/lwt +[github-actions]: https://github.com/ocsigen/lwt/actions
@@ -262,8 +259,7 @@ This list surveys them, roughly in order of importance. in the Lwt repo. - [`src/util/`][util-dir] contains various scripts, such as the - [configure script][configure.ml], [Travis][travis] and [AppVeyor][appveyor] - scripts, etc. + [configure script][configure.ml] scripts, etc. [core-dir]: https://github.com/ocsigen/lwt/tree/master/src/core [lwt.ml]: https://github.com/ocsigen/lwt/blob/master/src/core/lwt.ml @@ -279,6 +275,3 @@ This list surveys them, roughly in order of importance. [react-dir]: https://github.com/ocsigen/lwt/tree/master/src/react [Lwt_react]: https://github.com/ocsigen/lwt/blob/master/src/react/lwt_react.mli [util-dir]: https://github.com/ocsigen/lwt/tree/master/src/util -[configure.ml]: https://github.com/ocsigen/lwt/blob/master/src/util/configure.ml -[travis]: https://github.com/ocsigen/lwt/blob/master/src/util/travis.sh -[appveyor]: https://github.com/ocsigen/lwt/blob/master/src/util/appveyor-install.sh diff --git a/src/util/appveyor-build.sh b/src/util/appveyor-build.sh deleted file mode 100644 index 60256b62fd..0000000000 --- a/src/util/appveyor-build.sh +++ /dev/null @@ -1,27 +0,0 @@ -set -e -set -x - -eval `opam config env` - -date - -if [ -d _cache/_build ] -then - cp -r _cache/_build . -fi - -make build - -date - -dune runtest --force - -date - -if [ ! -d _cache/_build ] -then - mkdir -p _cache - cp -r _build _cache -fi - -date diff --git a/src/util/appveyor-install.sh b/src/util/appveyor-install.sh deleted file mode 100644 index 47e0aa3cf2..0000000000 --- a/src/util/appveyor-install.sh +++ /dev/null @@ -1,24 +0,0 @@ -set -e -set -x - -if [ "$APPVEYOR_SCHEDULED_BUILD" == True ] -then - rm -rf ~/.opam - rm -rf ./_cache -fi - -date - -opam init default https://github.com/fdopen/opam-repository-mingw.git#opam2 -c ocaml-variants.4.09.0+mingw64c --disable-sandboxing --yes --auto-setup - -date - -make dev-deps -opam clean - -eval `opam config env` - -opam --version -ocaml -version - -# You can twiddle this comment to invalidate the cache. diff --git a/src/util/style.css b/src/util/style.css deleted file mode 100644 index fb027163f5..0000000000 --- a/src/util/style.css +++ /dev/null @@ -1,171 +0,0 @@ -/* A style for ocamldoc. Daniel C. Buenzli, Jérémie Dimino */ - -body { - padding: 0em; - border: 0em; - margin: 2em 10% 2em 10%; - font-weight: normal; - line-height: 130%; - text-align: justify; - background: white; - color : black; - min-width: 40ex; -} - -pre, p, div, span, img, table, td, ol, ul, li { - padding: 0em; - border: 0em; - margin: 0em -} - -h1, h2, h3, h4, h5, h6, div.h7, div.h8, div.h9 { - fontsize: 100%; - margin-bottom: 1em - padding: 1ex 0em 0em 0em; - border: 0em; - margin: 1em 0em 0em 0em; - font-weight : bold; - text-align: center; -} - -h1 { - font-size : 140% -} - -h2, h3, h4, h5, h6, div.h7, div.h8, div.h9 { - font-size : 100%; - border-top-style : none; - margin: 1ex 0em 0em 0em; - border: 1px solid #000000; - margin-top: 5px; - margin-bottom: 2px; - text-align: center; - padding: 2px; -} - -h2 { - font-size : 120%; - background-color: #90BDFF ; -} -h3 { - background-color: #90DDFF; -} -h4 { - background-color: #90EDFF; -} -h5 { - background-color: #90FDFF; -} -h6 { - background-color: #C0FFFF; -} -div.h7 { - background-color: #E0FFFF; -} -div.h8 { - background-color: #F0FFFF; -} -div.h9 { - background-color: #FFFFFF; -} - -.navbar { - padding-bottom : 1em; - margin-bottom: 1em; - border-bottom: 1px solid #000000; - border-bottom-style: dotted; -} - -p { - padding: 1em 0ex 0em 0em -} - -a, a:link, a:visited, a:active, a:hover { - color : #009; - text-decoration: none -} -a:hover { - color : #009; - text-decoration : none; - background-color: #5FFF88 -} - -hr { - border-style: none; -} -table { - font-size : 100% /* Why ? */ -} -ul li { - padding: 1em 0em 0em 0em; - margin:0em 0em 0em 2.5ex -} -ol li { - padding: 1em 0em 0em 0em; - margin:0em 0em 0em 2em -} - -pre { - margin: 3ex 0em 1ex 0em; - background-color: #edf0f9; -} -.keyword { - font-weight: bold; - color: #a020f0; -} -.keywordsign { - font-weight: bold; - color: #a020f0; -} -.typefieldcomment { - color : #b22222; -} -.keywordsign { - color: #a020f0; - -} -.code { - font-size: 120%; - color: #5f5f5f; -} -.info { - margin: 0em 0em 0em 2em -} -.comment { - color : #b22222; -} -.constructor { - color : #072 -} -.type { - color : #228b22; -} -.string { - color : #bc8f8f; -} -.warning { - color : Red; - font-weight : bold -} - -div.sig_block { - margin-left: 2em -} -.typetable { - color : #b8860b; - border-style : hidden -} -.indextable { - border-style : hidden -} -.paramstable { - border-style : hidden; - padding: 5pt 5pt -} - -.superscript { - font-size : 80% -} -.subscript { - font-size : 80% -} diff --git a/src/util/travis-docs.sh b/src/util/travis-docs.sh deleted file mode 100644 index 8350ca1fe0..0000000000 --- a/src/util/travis-docs.sh +++ /dev/null @@ -1,66 +0,0 @@ -set -x - -date - -BUILD_DOCS=yes -[ "$DOCS" == yes ] || BUILD_DOCS=no -[ "$TRAVIS_BRANCH" == master ] || BUILD_DOCS=no -[ "$TRAVIS_PULL_REQUEST" == false ] || BUILD_DOCS=no -[ "$TRAVIS_EVENT_TYPE" != cron ] || BUILD_DOCS=no -[ "$TRAVIS_REPO_SLUG" == ocsigen/lwt ] || BUILD_DOCS=no -[ "$TRAVIS_TAG" == "" ] || BUILD_DOCS=no - -if [ "$BUILD_DOCS" == yes ] -then - opam pin add -y wikidoc git+https://github.com/ocsigen/wikidoc.git - opam install --unset-root -y uchar - make doc-api-wiki - - set +x - echo $DOCS_DEPLOY_KEY | base64 --decode > ~/.ssh/docs - chmod 400 ~/.ssh/docs - echo >> ~/.ssh/config - echo "Host github.com" >> ~/.ssh/config - echo " IdentityFile ~/.ssh/docs" >> ~/.ssh/config - echo " StrictHostKeyChecking no" >> ~/.ssh/config - set -x - - date - - git clone git@github.com:ocsigen/lwt.git lwt-docs - cd lwt-docs - git config user.name "Anton Bachin" - git config user.email "antonbachin@yahoo.com" - git checkout wikidoc - rm -rf docs/dev - mkdir -p docs/dev/api - mkdir -p docs/dev/manual - cp -r ../docs/api/wiki/* docs/dev/api - cp ../docs/*.wiki docs/dev/manual - - date - - git add -A - if ! git diff-index --quiet --exit-code HEAD - then - MESSAGE="Development docs" - LAST=`git log -1 --pretty=%B | head -n 1` - if [ "$LAST" == "$MESSAGE" ] - then - AMEND=--amend --reset-author - else - AMEND= - fi - git commit $AMEND -m "$MESSAGE" - git push --force-with-lease - fi - - cd .. - - date - - opam pin remove --no-action wikidoc - opam remove -y lwt -fi - -date From b485947fbce3e3e30e1eac51bae9bbf0e4f1c7ae Mon Sep 17 00:00:00 2001 From: Arvid Jakobsson Date: Fri, 1 Nov 2024 10:16:37 +0100 Subject: [PATCH 2/9] [test_lwt_engine.ml]: remove [selection_tests] Not sure, but it seems like this test is a noop if we assume that neither Travis nor Appveyor is used. --- test/unix/test_lwt_engine.ml | 24 +----------------------- 1 file changed, 1 insertion(+), 23 deletions(-) diff --git a/test/unix/test_lwt_engine.ml b/test/unix/test_lwt_engine.ml index 3b6a5d231e..464bbd5444 100644 --- a/test/unix/test_lwt_engine.ml +++ b/test/unix/test_lwt_engine.ml @@ -6,28 +6,6 @@ open Test open Lwt.Infix -let selection_tests = [ - test "libev: default when enabled in build bot" - (fun () -> - if not Lwt_config._HAVE_LIBEV then Lwt.return_true - else - (* Check if this is running inside Travis or AppVeyor. *) - let in_travis = - try ignore (Sys.getenv "TRAVIS_COMMIT"); true - with Not_found -> false - in - - let in_appveyor = - try ignore (Sys.getenv "APPVEYOR_REPO_COMMIT"); true - with Not_found -> false - in - - if not (in_travis || in_appveyor) then Lwt.return_true - else Lwt.return Lwt_config.libev_default); -] - -let tests = selection_tests - let timing_tests = [ test "libev: timer delays are not too short" begin fun () -> let start = Unix.gettimeofday () in @@ -57,7 +35,7 @@ let timing_tests = [ end; ] -let tests = tests @ timing_tests +let tests = timing_tests let run_tests = [ test "Lwt_main.run: nested call" ~sequential:true begin fun () -> From c2c27b032d16341d576bd2f3b89e393d68e25238 Mon Sep 17 00:00:00 2001 From: Arvid Jakobsson Date: Fri, 1 Nov 2024 10:12:17 +0100 Subject: [PATCH 3/9] [README.md]: remove appveyor cruft --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index 1c94c14d96..a46d7b963f 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,6 @@ [releases]: https://github.com/ocsigen/lwt/releases [github-actions]: https://github.com/ocsigen/lwt/actions [github-actions-img]: https://github.com/ocsigen/lwt/actions/workflows/workflow.yml/badge.svg?branch=master -[appveyor]: https://ci.appveyor.com/project/aantron/lwt/branch/master -[appveyor-img]: https://img.shields.io/appveyor/ci/aantron/lwt/master.svg?label=appveyor Lwt is a concurrent programming library for OCaml. It provides a single data type: the *promise*, which is a value that will become determined in the future. From 29e792ef2066a2349a7eb708a782c870035ffb95 Mon Sep 17 00:00:00 2001 From: Arvid Jakobsson Date: Fri, 1 Nov 2024 09:58:17 +0100 Subject: [PATCH 4/9] [CONTRIBUTING.md]: Recommend 4.08.2 switch --- docs/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index c09acb6372..d0e96a9114 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -76,7 +76,7 @@ Now, we need to install Lwt's development dependencies. Before doing that, you may want to switch to a special OPAM switch for working on Lwt: ``` -opam switch 4.06.1-lwt --alias-of 4.06.1 # optional +opam switch create . 4.08.2 --no-install # optional eval `opam config env` # optional make dev-deps ``` From d4e88975a96bf39e86918e12d0fa4daaa23bdb91 Mon Sep 17 00:00:00 2001 From: Arvid Jakobsson Date: Fri, 1 Nov 2024 10:07:01 +0100 Subject: [PATCH 5/9] [CONTRIBUTING.md]: Fix manual link --- docs/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index d0e96a9114..ca515c62f4 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -217,7 +217,7 @@ fixing that. [documented `Lwt_unix.getcwd`][unix-model] as a model function. - Everything else is sparsely documented in comments. -[manual]: https://ocsigen.org/lwt/manual/ +[manual]: https://ocsigen.org/lwt/ [lwt.ml]: https://github.com/ocsigen/lwt/blob/master/src/core/lwt.ml [unix-model]: https://github.com/ocsigen/lwt/blob/99d1ec8b5c159456855eb2f55ddab77207bc92b3/src/unix/unix_c/unix_getcwd_job.c#L36 From 5902d688bada125bd38939782e2b8e517bf9e69f Mon Sep 17 00:00:00 2001 From: Arvid Jakobsson Date: Fri, 1 Nov 2024 10:10:43 +0100 Subject: [PATCH 6/9] [README.md]: remove unused irc link --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index a46d7b963f..dddfd303b2 100644 --- a/README.md +++ b/README.md @@ -132,7 +132,6 @@ Release announcements are made in [/r/ocaml][reddit], and on [discuss.ocaml.org][discourse]. Watching the repo for "Releases only" is also an option. -[irc]: http://webchat.freenode.net/?channels=#ocaml [so]: http://stackoverflow.com/questions/ask?tags=ocaml,lwt,ocaml-lwt [announcements]: https://github.com/ocsigen/lwt/issues/309 [reddit]: https://www.reddit.com/r/ocaml/ From 314172474ae780082f201e20beb2821900c9924d Mon Sep 17 00:00:00 2001 From: Arvid Jakobsson Date: Fri, 1 Nov 2024 10:19:07 +0100 Subject: [PATCH 7/9] [README.md]: remove unused links --- README.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/README.md b/README.md index dddfd303b2..9e94cc3bc4 100644 --- a/README.md +++ b/README.md @@ -133,9 +133,7 @@ Release announcements are made in [/r/ocaml][reddit], and on option. [so]: http://stackoverflow.com/questions/ask?tags=ocaml,lwt,ocaml-lwt -[announcements]: https://github.com/ocsigen/lwt/issues/309 [reddit]: https://www.reddit.com/r/ocaml/ -[caml-list]: https://sympa.inria.fr/sympa/arc/caml-list [discourse]: https://discuss.ocaml.org/tag/lwt [issues]: https://github.com/ocsigen/lwt/issues/new [discord]: https://discordapp.com/invite/cCYQbqN @@ -156,7 +154,6 @@ option. - Any feedback is welcome, including how to make contributing easier! [issues-and-prs]: https://github.com/ocsigen/lwt/issues?utf8=%E2%9C%93&q=is%3Aopen -[all-issues]: https://github.com/ocsigen/lwt/issues [contributing-md]: https://github.com/ocsigen/lwt/blob/master/docs/CONTRIBUTING.md#readme From 59006a912de1b21b66a9abdb16bac00bf4f795a1 Mon Sep 17 00:00:00 2001 From: Arvid Jakobsson Date: Fri, 1 Nov 2024 10:11:24 +0100 Subject: [PATCH 8/9] [README.md]: make links [https] Docs: fix broken links and redirects --- README.md | 12 ++++++------ docs/manual.mld | 6 +++--- src/core/index.mld | 6 +++--- src/core/lwt.mli | 6 +++--- src/core/lwt_condition.ml | 2 +- src/core/lwt_condition.mli | 2 +- src/core/lwt_mvar.ml | 2 +- src/core/lwt_mvar.mli | 2 +- src/core/lwt_pqueue.mli | 8 ++++---- src/ppx/ppx_lwt.mli | 2 +- src/unix/lwt_fmt.mli | 2 +- src/unix/lwt_unix.cppo.mli | 10 +++++----- 12 files changed, 30 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index 9e94cc3bc4..f56c460f3b 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![version][version]][releases] [![GitHub Actions status][github-actions-img]][github-actions] -[version]: https://img.shields.io/github/release/ocsigen/lwt +[version]: https://img.shields.io/github/v/release/ocsigen/lwt [releases]: https://github.com/ocsigen/lwt/releases [github-actions]: https://github.com/ocsigen/lwt/actions [github-actions-img]: https://github.com/ocsigen/lwt/actions/workflows/workflow.yml/badge.svg?branch=master @@ -115,10 +115,10 @@ rewriting the manual). In the meantime: or just "threads." This will be fixed in the new manual. `'a Lwt.t` is a promise, and has nothing to do with system or preemptive threads.* -[manual]: http://ocsigen.org/lwt/ +[manual]: https://ocsigen.org/lwt/ [rwo-lwt]: https://github.com/dkim/rwo-lwt#readme [mirage-tutorial]: https://mirage.io/docs/tutorial-lwt -[counter-server]: http://www.baturin.org/code/lwt-counter-server/ +[counter-server]: https://baturin.org/code/lwt-counter-server/
@@ -132,11 +132,11 @@ Release announcements are made in [/r/ocaml][reddit], and on [discuss.ocaml.org][discourse]. Watching the repo for "Releases only" is also an option. -[so]: http://stackoverflow.com/questions/ask?tags=ocaml,lwt,ocaml-lwt +[so]: https://stackoverflow.com/questions/ask?tags=ocaml,lwt,ocaml-lwt [reddit]: https://www.reddit.com/r/ocaml/ [discourse]: https://discuss.ocaml.org/tag/lwt [issues]: https://github.com/ocsigen/lwt/issues/new -[discord]: https://discordapp.com/invite/cCYQbqN +[discord]: https://discord.com/invite/cCYQbqN
@@ -174,7 +174,7 @@ JSON parsing and output serialization combinators - [logs](https://github.com/dbuenzli/logs) — logging -- [lwt-parallel](https://github.com/ivg/parallel) — +- [lwt-parallel](https://github.com/ivg/lwt-parallel) — distributed computing - [mwt](https://github.com/hcarty/mwt) — preemptive (system) thread pools - [opium](https://github.com/rgrinberg/opium) — diff --git a/docs/manual.mld b/docs/manual.mld index 946867ce70..df72da2417 100644 --- a/docs/manual.mld +++ b/docs/manual.mld @@ -51,8 +51,8 @@ {ul {- {{: https://github.com/dkim/rwo-lwt#readme }Concurrent Programming with Lwt}} - {- {{: https://mirage.io/wiki/tutorial-lwt }Mirage Lwt Tutorial}} - {- {{: http://www.baturin.org/code/lwt-counter-server/ }Simple Server with Lwt}}} + {- {{: https://mirage.io/docs/tutorial-lwt }Mirage Lwt Tutorial}} + {- {{: https://baturin.org/code/lwt-counter-server/ }Simple Server with Lwt}}} {1 The Lwt core library } @@ -695,7 +695,7 @@ val Lwt_main.run : 'a Lwt.t -> 'a To make sure [Lwt] is compiled with [libev] support, tell opam that the library is available on the system by installing the - {{: http://opam.ocaml.org/packages/conf-libev/conf-libev.4-11/ }conf-libev} + {{: https://opam.ocaml.org/packages/conf-libev/conf-libev.4-11/ }conf-libev} package. You may get the actual library with your system package manager: {ul diff --git a/src/core/index.mld b/src/core/index.mld index 603f259256..f82f4abc85 100644 --- a/src/core/index.mld +++ b/src/core/index.mld @@ -79,12 +79,12 @@ In Lwt, {1 Additional Docs} -- {{!page-manual} Manual} ({{:http://ocsigen.org/lwt/} Online manual}). +- {{!page-manual} Manual} ({{:https://ocsigen.org/lwt/} Online manual}). - {{:https://github.com/dkim/rwo-lwt#readme} Concurrent Programming with Lwt} is a nice source of Lwt examples. They are translations of code from Real World OCaml, but are just as useful if you are not reading the book. -- {{:https://mirage.io/wiki/tutorial-lwt} Mirage Lwt tutorial}. -- {{:http://www.baturin.org/code/lwt-counter-server/} Example server} written +- {{:https://mirage.io/docs/tutorial-lwt} Mirage Lwt tutorial}. +- {{:https://baturin.org/code/lwt-counter-server/} Example server} written with Lwt. diff --git a/src/core/lwt.mli b/src/core/lwt.mli index 552c536b58..7598343d84 100644 --- a/src/core/lwt.mli +++ b/src/core/lwt.mli @@ -231,9 +231,9 @@ let () = pending), or containers for one value (if resolved). The interesting function is {!Lwt_main.run}. It's a wrapper around - {{: http://man7.org/linux/man-pages/man2/select.2.html} [select(2)]}, - {{: http://man7.org/linux/man-pages/man7/epoll.7.html} [epoll(7)]}, - {{: https://www.freebsd.org/cgi/man.cgi?query=kqueue&sektion=2} + {{: https://man7.org/linux/man-pages/man2/select.2.html} [select(2)]}, + {{: https://man7.org/linux/man-pages/man7/epoll.7.html} [epoll(7)]}, + {{: https://man.freebsd.org/cgi/man.cgi?query=kqueue&sektion=2} [kqueue(2)]}, or whatever asynchronous I/O API your system provides. On browsers, the work of {!Lwt_main.run} is done by the surrounding JavaScript engine, so you don't call {!Lwt_main.run} from inside your program. But the diff --git a/src/core/lwt_condition.ml b/src/core/lwt_condition.ml index 0ff854d327..1e18f0b035 100644 --- a/src/core/lwt_condition.ml +++ b/src/core/lwt_condition.ml @@ -1,5 +1,5 @@ (* OCaml promise library - * http://www.ocsigen.org/lwt + * https://ocsigen.org/lwt * Copyright (c) 2009, Metaweb Technologies, Inc. * All rights reserved. * diff --git a/src/core/lwt_condition.mli b/src/core/lwt_condition.mli index 009004611b..be39440a41 100644 --- a/src/core/lwt_condition.mli +++ b/src/core/lwt_condition.mli @@ -1,5 +1,5 @@ (* OCaml promise library - * http://www.ocsigen.org/lwt + * https://ocsigen.org/lwt * Copyright (c) 2009, Metaweb Technologies, Inc. * All rights reserved. * diff --git a/src/core/lwt_mvar.ml b/src/core/lwt_mvar.ml index d7a949150a..ea96bd65a9 100644 --- a/src/core/lwt_mvar.ml +++ b/src/core/lwt_mvar.ml @@ -1,5 +1,5 @@ (* OCaml promise library - * http://www.ocsigen.org/lwt + * https://ocsigen.org/lwt * Copyright (c) 2009, Metaweb Technologies, Inc. * All rights reserved. * diff --git a/src/core/lwt_mvar.mli b/src/core/lwt_mvar.mli index b05af2c4ce..8e857e1b0f 100644 --- a/src/core/lwt_mvar.mli +++ b/src/core/lwt_mvar.mli @@ -1,5 +1,5 @@ (* OCaml promise library - * http://www.ocsigen.org/lwt + * https://ocsigen.org/lwt * Copyright (c) 2009, Metaweb Technologies, Inc. * All rights reserved. * diff --git a/src/core/lwt_pqueue.mli b/src/core/lwt_pqueue.mli index 0e5c12517d..d0a0f04b0a 100644 --- a/src/core/lwt_pqueue.mli +++ b/src/core/lwt_pqueue.mli @@ -15,15 +15,15 @@ @deprecated This module is an internal implementation detail of Lwt, and may be removed from the API at some point in the future. For alternatives, see, - for example: {{: https://www.lri.fr/~filliatr/software.en.html#heap} Heaps} + for example: {{: https://usr.lmf.cnrs.fr/~jcf/software.en.html#heap} Heaps} by Jean-Cristophe Filliatre, - {{: http://cedeela.fr/~simon/software/containers/CCHeap.html} containers}, - {{: http://ocaml-batteries-team.github.io/batteries-included/hdoc2/BatHeap.html} + {{: https://simon.cedeela.fr/~simon/software/containers/CCHeap.html} containers}, + {{: https://ocaml-batteries-team.github.io/batteries-included/hdoc2/BatHeap.html} Batteries}, or {{:https://github.com/pqwy/psq} psq}. *) [@@@ocaml.deprecated " This module is an implementation detail of Lwt. See - http://ocsigen.org/lwt/dev/api/Lwt_pqueue"] + https://ocsigen.org/lwt/latest/api/Lwt_pqueue"] (** Signature pairing an element type with an ordering function. *) module type OrderedType = diff --git a/src/ppx/ppx_lwt.mli b/src/ppx/ppx_lwt.mli index 0912c07e01..577630c13f 100644 --- a/src/ppx/ppx_lwt.mli +++ b/src/ppx/ppx_lwt.mli @@ -9,7 +9,7 @@ (** {2 Ppx extensions} This Ppx extension adds various syntactic shortcut for lwt programming. - It needs {{:https://github.com/alainfrisch/ppx_tools}ppx_tools}. + It needs {{:https://github.com/ocaml-ppx/ppx_tools}ppx_tools}. To use it, simply use the ocamlfind package [lwt_ppx]. diff --git a/src/unix/lwt_fmt.mli b/src/unix/lwt_fmt.mli index 51740e2ccb..83cfd3ce8d 100644 --- a/src/unix/lwt_fmt.mli +++ b/src/unix/lwt_fmt.mli @@ -9,7 +9,7 @@ (** This module bridges the gap between {!Stdlib.Format} and {!Lwt}. Although it is not required, it is recommended to use this module - with the {{:http://erratique.ch/software/fmt} [Fmt]} library. + with the {{:https://erratique.ch/software/fmt} [Fmt]} library. Compared to regular formatting function, the main difference is that printing statements will now return promises instead of blocking. diff --git a/src/unix/lwt_unix.cppo.mli b/src/unix/lwt_unix.cppo.mli index df5d082067..c36d9a4709 100644 --- a/src/unix/lwt_unix.cppo.mli +++ b/src/unix/lwt_unix.cppo.mli @@ -435,7 +435,7 @@ val readv : file_descr -> IO_vectors.t -> int Lwt.t Not implemented on Windows. It should be possible to implement, upon request, for Windows sockets only. - See {{:http://man7.org/linux/man-pages/man3/readv.3p.html} [readv(3p)]}. + See {{:https://man7.org/linux/man-pages/man3/readv.3p.html} [readv(3p)]}. @since 2.7.0 *) @@ -464,7 +464,7 @@ val writev : file_descr -> IO_vectors.t -> int Lwt.t and write zero bytes. On BSD (including macOS), [writev] will fail with [Unix.Unix_error (Unix.EINVAL, "writev", ...)]. - See {{:http://man7.org/linux/man-pages/man3/writev.3p.html} + See {{:https://man7.org/linux/man-pages/man3/writev.3p.html} [writev(3p)]}. @since 2.7.0 *) @@ -586,7 +586,7 @@ val utimes : string -> float -> float -> unit Lwt.t to [mtime]. To set both to the current time, call [utimes path 0. 0.]. This function corresponds to {!Unix.utimes}. See also - {{:http://man7.org/linux/man-pages/man3/utimes.3p.html} [utimes(3p)]}. + {{:https://man7.org/linux/man-pages/man3/utimes.3p.html} [utimes(3p)]}. @since 2.6.0 *) @@ -893,7 +893,7 @@ val socketpair : ?cloexec:bool -> val bind : file_descr -> sockaddr -> unit Lwt.t (** Binds an address to the given socket. This is the cooperative analog of {!Unix.bind}. See also - {{:http://man7.org/linux/man-pages/man3/bind.3p.html} [bind(3p)]}. + {{:https://man7.org/linux/man-pages/man3/bind.3p.html} [bind(3p)]}. @since 3.0.0 *) @@ -922,7 +922,7 @@ val accept_n : ?cloexec:bool -> [accept_n] has the advantage of improving performance. If you want a more detailed description, you can have a look at: - {{:http://portal.acm.org/citation.cfm?id=1247435}Acceptable strategies for improving web server performance} *) + {{:https://dl.acm.org/doi/10.5555/1247415.1247435}Acceptable strategies for improving web server performance} *) val connect : file_descr -> sockaddr -> unit Lwt.t (** Wrapper for {!Unix.connect} *) From 4e91f6d9f124075df8479fde1ec1a47580e813d3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rapha=C3=ABl=20Proust?= Date: Fri, 8 Nov 2024 15:13:23 +0100 Subject: [PATCH 9/9] Further improve the README - drop reddit info (deprecated) - add reference to lwt_domain --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f56c460f3b..12ef39f49f 100644 --- a/README.md +++ b/README.md @@ -128,12 +128,10 @@ promise, and has nothing to do with system or preemptive threads.* Open an [issue][issues], visit [Discord][discord] chat, ask on [discuss.ocaml.org][discourse], or on [Stack Overflow][so]. -Release announcements are made in [/r/ocaml][reddit], and on -[discuss.ocaml.org][discourse]. Watching the repo for "Releases only" is also an -option. +Release announcements are made on [discuss.ocaml.org][discourse]. Watching the +repo for "Releases only" is also an option. [so]: https://stackoverflow.com/questions/ask?tags=ocaml,lwt,ocaml-lwt -[reddit]: https://www.reddit.com/r/ocaml/ [discourse]: https://discuss.ocaml.org/tag/lwt [issues]: https://github.com/ocsigen/lwt/issues/new [discord]: https://discord.com/invite/cCYQbqN @@ -179,3 +177,5 @@ distributed computing - [mwt](https://github.com/hcarty/mwt) — preemptive (system) thread pools - [opium](https://github.com/rgrinberg/opium) — web framework +- [lwt_domain](https://github.com/ocsigen/lwt_domain) — domain parallelism when + using Lwt with OCaml 5