The unpac monorepo manager self-hosting as a monorepo using unpac

Merge pull request #813 from jonludlam/doc-fixes

Documentation fixes

authored by

Thomas Leonard and committed by
GitHub
d39da113 d38a31ca

+71 -7
+26
doc/dune
··· 3 3 (deps (package eio_main) (env_var "EIO_BACKEND")) 4 4 (enabled_if (<> %{os_type} "Win32")) 5 5 (files multicore.md)) 6 + 7 + (install 8 + (section doc) 9 + (files 10 + (odoc-config-eio.sexp as odoc-config.sexp)) 11 + (package eio)) 12 + 13 + (install 14 + (section doc) 15 + (files 16 + odoc-config.sexp) 17 + (package eio_linux)) 18 + 19 + (install 20 + (section doc) 21 + (files 22 + odoc-config.sexp) 23 + (package eio_posix)) 24 + 25 + (install 26 + (section doc) 27 + (files 28 + odoc-config.sexp) 29 + (package eio_windows)) 30 + 31 +
+3
doc/odoc-config-eio.sexp
··· 1 + (libraries unix) 2 + (packages eio_main bigstring) 3 +
+2
doc/odoc-config.sexp
··· 1 + (packages eio_main) 2 +
+4
eio.opam
··· 42 42 ] 43 43 ] 44 44 dev-repo: "git+https://github.com/ocaml-multicore/eio.git" 45 + x-extra-doc-deps: [ 46 + "eio_main" {= version} 47 + "bigstring" 48 + ]
+4
eio.opam.template
··· 1 + x-extra-doc-deps: [ 2 + "eio_main" {= version} 3 + "bigstring" 4 + ]
+3
eio_linux.opam
··· 34 34 ] 35 35 dev-repo: "git+https://github.com/ocaml-multicore/eio.git" 36 36 available: [os = "linux"] 37 + x-extra-doc-deps: [ 38 + "eio_main" {= version} 39 + ]
+3
eio_linux.opam.template
··· 1 1 available: [os = "linux"] 2 + x-extra-doc-deps: [ 3 + "eio_main" {= version} 4 + ]
+3
eio_main.opam
··· 35 35 ] 36 36 dev-repo: "git+https://github.com/ocaml-multicore/eio.git" 37 37 x-ci-accept-failures: ["macos-homebrew"] 38 + x-extra-doc-deps: [ 39 + "eio_main" {= version} 40 + ]
+3
eio_main.opam.template
··· 1 1 x-ci-accept-failures: ["macos-homebrew"] 2 + x-extra-doc-deps: [ 3 + "eio_main" {= version} 4 + ]
+3
eio_posix.opam
··· 31 31 ] 32 32 ] 33 33 dev-repo: "git+https://github.com/ocaml-multicore/eio.git" 34 + x-extra-doc-deps: [ 35 + "eio_main" {= version} 36 + ]
+3
eio_posix.opam.template
··· 1 + x-extra-doc-deps: [ 2 + "eio_main" {= version} 3 + ]
+3
eio_windows.opam
··· 31 31 ] 32 32 dev-repo: "git+https://github.com/ocaml-multicore/eio.git" 33 33 #available: [os = "win32"] 34 + x-extra-doc-deps: [ 35 + "eio_main" {= version} 36 + ]
+3
eio_windows.opam.template
··· 1 1 #available: [os = "win32"] 2 + x-extra-doc-deps: [ 3 + "eio_main" {= version} 4 + ]
+1 -1
lib_eio/condition.mli
··· 97 97 Therefore, care is needed here. This is typically used to send a wake-up event to some non-Eio library. *) 98 98 99 99 val cancel : request -> bool 100 - (** [cancel request] tries to cancel a request created with {!register_unsafe}. 100 + (** [cancel request] tries to cancel a request created with {!register_immediate}. 101 101 102 102 It returns [true] if the request was cancelled (the callback will never be called), 103 103 or [false] if the request was already complete (the callback has already been called). *)
+1 -1
lib_eio/core/eio__core.mli
··· 382 382 383 383 val get : 'a key -> 'a option 384 384 (** [get key] reads [key] from the map of fiber local variables, returning its 385 - value or {!None} if it has not been bound. *) 385 + value or [None] if it has not been bound. *) 386 386 387 387 val with_binding : 'a key -> 'a -> (unit -> 'b) -> 'b 388 388 (** [with_binding key value fn] runs [fn] with [key] bound to the provided
+1 -1
lib_eio/file.mli
··· 29 29 (** Kind of file from st_mode. **) 30 30 31 31 val pp_kind : kind Fmt.t 32 - (** Pretty printer for {! kind}. *) 32 + (** Pretty printer for {!type-kind}. *) 33 33 34 34 type t = { 35 35 dev : Int64.t; (** Device containing the filesystem where the file resides. *)
+1 -1
lib_eio/flow.mli
··· 127 127 val copy : t -> src:_ source -> unit 128 128 (** [copy t ~src] allows for optimising copy operations. 129 129 130 - If you have no optimisations, you can use {!simple_copy} to implement this using {!single_write}. *) 130 + If you have no optimisations, you can use {!Eio.Flow.Pi.simple_copy} to implement this using {!single_write}. *) 131 131 end 132 132 133 133 module type SHUTDOWN = sig
+1 -1
lib_eio/net.mli
··· 71 71 72 72 (** {2 Interoperability} 73 73 74 - To convert to or from OCaml Unix addresses, use {!Eio_unix.Ipaddr}. 74 + To convert to or from OCaml Unix addresses, use {!Eio_unix.Net.Ipaddr}. 75 75 76 76 To interoperate with the {{:https://opam.ocaml.org/packages/ipaddr/} ipaddr} library: 77 77 - [Ipaddr.to_octets ipaddr_ip |> Eio.Net.Ipaddr.of_raw]
+1
lib_eio/unix/eio_unix.mli
··· 101 101 102 102 module Rcfd = Rcfd 103 103 104 + (** @canonical Eio_unix.Private.Fork_action *) 104 105 module Fork_action = Fork_action 105 106 106 107 module Thread_pool = Thread_pool
+1 -1
lib_eio/unix/process.mli
··· 61 61 (** [spawn_unix ~sw mgr ~fds args] spawns a child process running the command [args]. 62 62 63 63 The arguments are as for {!Eio.Process.spawn}, 64 - except that it takes a list of FD mappings for {!Fork_action.inherit_fds} 64 + except that it takes a list of FD mappings for {!Private.Fork_action.inherit_fds} 65 65 directly, rather than just flows for the standard streams. *) 66 66 67 67 val sigchld : Eio.Condition.t
+1 -1
lib_eio_linux/low_level.mli
··· 109 109 110 110 @return The number of bytes copied. 111 111 @raise End_of_file [src] is at the end of the file. 112 - @raise Unix.Unix_error(EINVAL, "splice", _) if splice is not supported for these FDs. *) 112 + @raise Unix.Unix_error with args [(EINVAL, "splice", _)] if splice is not supported for these FDs. *) 113 113 114 114 val connect : fd -> Unix.sockaddr -> unit 115 115 (** [connect fd addr] attempts to connect socket [fd] to [addr]. *)