Skip to content

docs: replace above-U+00FF characters with 8-bit equivalents #347

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.

Sign up for GitHub

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

Open
peter-lawrey wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

docs: replace above-U+00FF characters with 8-bit equivalents #347

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions src/main/adoc/project-requirements.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= Chronicle Threads – Functional Requirements Specification
= Chronicle Threads - Functional Requirements Specification
:revnumber: 1.0
:revdate: 2025-05-25
:toc:
Expand Down Expand Up @@ -28,7 +28,7 @@ ultra-low-latency, event-driven Java systems.
|*EventHandler* |Application-provided component that implements `action()`; executed by an `EventLoop`.
|*EventGroup* |A container that manages one or more `EventLoop`s, potentially including a dedicated monitor loop.
|*Pauser* |Strategy object that controls how an idle loop waits (e.g., busy-spin, yield, sleep).
|*Fast Thread* |A thread—usually pinned to an isolated CPU core—running a latency-critical event loop.
|*Fast Thread* |A thread--usually pinned to an isolated CPU core--running a latency-critical event loop.
|*Hot Path* / *Fast Path* |The code execution path that is performance-critical and frequently executed, where low latency and minimal overhead are paramount.
|*Loop-Block Monitor* |Background handler that measures `EventHandler` run-time and logs outliers exceeding a configured threshold.
|*NUMA* |Non-Uniform Memory Access; a memory architecture where memory access time depends on the memory location relative to a processor.
Expand All @@ -44,7 +44,7 @@ ultra-low-latency, event-driven Java systems.

== 4 High-Level Functional Requirements

=== 4.1 Event‐Loop Lifecycle and Configuration
=== 4.1 Event-Loop Lifecycle and Configuration

. *Creation and Configuration*
*THR-FN-001* The library SHALL provide builder APIs (e.g., `EventLoopBuilder`, `EventGroupBuilder`) for fluent and immutable configuration of event loops and groups.
Expand Down
6 changes: 3 additions & 3 deletions src/main/docs/project-requirements.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= Chronicle Threads – Functional Requirements Specification
= Chronicle Threads - Functional Requirements Specification
:revnumber: 1.0
:revdate: 2025-05-25
:sectnums:
Expand Down Expand Up @@ -26,7 +26,7 @@ _Out of scope_ are:
|_EventHandler_ |Application-provided component that implements `action()`; executed by an `EventLoop`.
|_EventGroup_ |A container that manages one or more `EventLoop`s, potentially including a dedicated monitor loop.
|_Pauser_ |Strategy object that controls how an idle loop waits (e.g., busy-spin, yield, sleep).
|_Fast Thread_ |A thread—usually pinned to an isolated CPU core—running a latency-critical event loop.
|_Fast Thread_ |A thread--usually pinned to an isolated CPU core--running a latency-critical event loop.
|_Hot Path_ / _Fast Path_ |The code execution path that is performance-critical and frequently executed, where low latency and minimal overhead are paramount.
|_Loop-Block Monitor_ |Background handler that measures `EventHandler` run-time and logs outliers exceeding a configured threshold.
|_NUMA_ |Non-Uniform Memory Access; a memory architecture where memory access time depends on the memory location relative to a processor.
Expand All @@ -42,7 +42,7 @@ _Out of scope_ are:

== High-Level Functional Requirements

=== Event‐Loop Lifecycle and Configuration
=== Event-Loop Lifecycle and Configuration

. _Creation and Configuration_
_THR-FN-001_ The library SHALL provide builder APIs (e.g., `EventLoopBuilder`, `EventGroupBuilder`) for fluent and immutable configuration of event loops and groups.
Expand Down