Skip to content

Commit

Permalink
Fmt issue.
Browse files Browse the repository at this point in the history
  • Loading branch information
lyrm committed Jan 7, 2025
1 parent 8797cea commit 4e760df
Showing 1 changed file with 21 additions and 20 deletions.
41 changes: 21 additions & 20 deletions src/saturn.mli
Original file line number Diff line number Diff line change
Expand Up @@ -30,26 +30,27 @@ Copyright (c) 2017, Nicolas ASSOUAD <[email protected]>

(** {1 Useful Information}
{2 Domain-Specific Data Structures}
Some data structures are optimized for specific domain configurations. These
restrictions enhance performance but must be adhered to for maintaining safety
properties. These limitations are documented and often reflected in the data
structure's name. For example, a single-consumer queue should only have one
domain performing `pop` operations at any time.
For more details, refer to this
{{: https://github.com/ocaml-multicore/saturn/blob/main/doc/domain-role.md}{document}}.
{2 Composability}
Composability is the ability to combine functions while preserving their
properties, such as atomic consistency (linearizability) and progress
guarantees (e.g., lock-freedom). Saturn's data structures, however, are not
composable.
For more details, refer to this
{{: https://github.com/ocaml-multicore/saturn/blob/main/doc/composability.md}{document}}.
*)
{2 Domain-Specific Data Structures}
Some data structures are optimized for specific domain configurations. These
restrictions enhance performance but must be adhered to for maintaining
safety properties. These limitations are documented and often reflected in
the data structure's name. For example, a single-consumer queue should only
have one domain performing `pop` operations at any time.
For more details, refer to this
{{:https://github.com/ocaml-multicore/saturn/blob/main/doc/domain-role.md}
document}.
{2 Composability}
Composability is the ability to combine functions while preserving their
properties, such as atomic consistency (linearizability) and progress
guarantees (e.g., lock-freedom). Saturn's data structures, however, are not
composable.
For more details, refer to this
{{:https://github.com/ocaml-multicore/saturn/blob/main/doc/composability.md}
document}. *)

(** {2 Unsafe Data Structures}
Expand Down

0 comments on commit 4e760df

Please sign in to comment.