Skip to content

Commit c9318d4

Browse files
committed
Documentation fixes
1 parent 6ec44ea commit c9318d4

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

README.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Processor Topology & Affinity for ocaml
22

3+
[API Online](https://haesbaert.github.io/ocaml-processor/)
4+
35
This library allows you to query the processor topology as well as set
46
the processor affinity for the current process. This library does
57
*not* depend on ocaml-5 (Multicore), but it can be used within ocaml-5

lib/cpu.mli

+4-2
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,10 @@
1515
*)
1616
(** Expresses a logical CPU/thread. *)
1717

18-
type kind = P_core | E_core
19-
(** The [kind] of a {!Cpu.t}: [Performance] or [Energy Efficient] *)
18+
type kind =
19+
| P_core (** Performance cpu, faster, power hungry one *)
20+
| E_core (** Energy efficient, slower, global warming aware one *)
21+
(** The [kind] of a {!Cpu.t} *)
2022

2123
type t = {
2224
id : int; (** A monotonically increasing id *)

0 commit comments

Comments
 (0)