Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Some clean up in CONTRIBUTING.md and fix broken links & redirects #1038

Merged
merged 9 commits into from
Nov 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 10 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,10 @@

[![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
[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.
Expand Down Expand Up @@ -117,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/


<br/>
Expand All @@ -130,18 +128,13 @@ 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.

[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/
[caml-list]: https://sympa.inria.fr/sympa/arc/caml-list
[so]: https://stackoverflow.com/questions/ask?tags=ocaml,lwt,ocaml-lwt
[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


<br/>
Expand All @@ -159,7 +152,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


Expand All @@ -180,8 +172,10 @@ 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) —
web framework
- [lwt_domain](https://github.com/ocsigen/lwt_domain) — domain parallelism when
using Lwt with OCaml 5
19 changes: 6 additions & 13 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,13 +76,11 @@ 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
```

[opam-depends]: https://github.com/ocsigen/lwt/blob/8bff603ae6d976e69698fa08e8ce08fe9615489d/opam/opam#L35-L44

On most systems, you should also [install libev][installing]:

```
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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


<br/>
Expand All @@ -220,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

Expand Down Expand Up @@ -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
Expand All @@ -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
6 changes: 3 additions & 3 deletions docs/manual.mld
Original file line number Diff line number Diff line change
Expand Up @@ -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 }

Expand Down Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions src/core/index.mld
Original file line number Diff line number Diff line change
Expand Up @@ -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.


Expand Down
6 changes: 3 additions & 3 deletions src/core/lwt.mli
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/core/lwt_condition.ml
Original file line number Diff line number Diff line change
@@ -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.
*
Expand Down
2 changes: 1 addition & 1 deletion src/core/lwt_condition.mli
Original file line number Diff line number Diff line change
@@ -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.
*
Expand Down
2 changes: 1 addition & 1 deletion src/core/lwt_mvar.ml
Original file line number Diff line number Diff line change
@@ -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.
*
Expand Down
2 changes: 1 addition & 1 deletion src/core/lwt_mvar.mli
Original file line number Diff line number Diff line change
@@ -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.
*
Expand Down
8 changes: 4 additions & 4 deletions src/core/lwt_pqueue.mli
Original file line number Diff line number Diff line change
Expand Up @@ -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 =
Expand Down
2 changes: 1 addition & 1 deletion src/ppx/ppx_lwt.mli
Original file line number Diff line number Diff line change
Expand Up @@ -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].

Expand Down
2 changes: 1 addition & 1 deletion src/unix/lwt_fmt.mli
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
10 changes: 5 additions & 5 deletions src/unix/lwt_unix.cppo.mli
Original file line number Diff line number Diff line change
Expand Up @@ -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 *)

Expand Down Expand Up @@ -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 *)
Expand Down Expand Up @@ -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 *)

Expand Down Expand Up @@ -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 *)

Expand Down Expand Up @@ -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} *)
Expand Down
27 changes: 0 additions & 27 deletions src/util/appveyor-build.sh

This file was deleted.

24 changes: 0 additions & 24 deletions src/util/appveyor-install.sh

This file was deleted.

Loading
Loading