Update README.md by ryan-steel · Pull Request #127 · eclipse-score/time

ryan-steel · 2026-07-15T14:23:13Z

Improvement

Description

Updates README.md to contain relevant info for the repo. Uses lifecycle as a guide.

Related ticket

closes #124 (improvement ticket)

github-actions · 2026-07-15T14:25:19Z

License Check Results

🚀 The license check job ran with the Bazel command:

bazel run //:license-check

Status: ⚠️ Needs Review

Click to expand output

[License Check Output]
Extracting Bazel installation...
Starting local Bazel server (8.6.0) and connecting to it...
INFO: Invocation ID: 032328dc-0cc9-4f3e-94d9-a86d921bf2f3
Computing main repo mapping: 
WARNING: /home/runner/work/time/time/MODULE.bazel:13:7: The attribute 'compatibility_level' in module() is a no-op and will be removed in a future Bazel release. Please remove it from your MODULE.bazel file.
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Loading: 
Loading: 3 packages loaded
Loading: 3 packages loaded
    currently loading: 
Loading: 3 packages loaded
    currently loading: 
Loading: 3 packages loaded
    currently loading: 
Loading: 3 packages loaded
    currently loading: 
Loading: 3 packages loaded
    currently loading: 
Analyzing: target //:license-check (4 packages loaded, 0 targets configured)
Analyzing: target //:license-check (4 packages loaded, 0 targets configured)

Analyzing: target //:license-check (48 packages loaded, 10 targets configured)

Analyzing: target //:license-check (87 packages loaded, 10 targets configured)

Analyzing: target //:license-check (140 packages loaded, 2324 targets configured)

Analyzing: target //:license-check (153 packages loaded, 5569 targets configured)

Analyzing: target //:license-check (154 packages loaded, 9108 targets configured)

Analyzing: target //:license-check (164 packages loaded, 9264 targets configured)

Analyzing: target //:license-check (165 packages loaded, 9284 targets configured)

Analyzing: target //:license-check (165 packages loaded, 9284 targets configured)

Analyzing: target //:license-check (165 packages loaded, 9284 targets configured)

Analyzing: target //:license-check (166 packages loaded, 9284 targets configured)

Analyzing: target //:license-check (169 packages loaded, 11296 targets configured)

INFO: Analyzed target //:license-check (170 packages loaded, 11422 targets configured).
[12 / 16] JavaToolchainCompileClasses external/rules_java+/toolchains/platformclasspath_classes; 0s disk-cache, processwrapper-sandbox ... (2 actions running)
INFO: From Generating Dash formatted dependency file ...:
INFO: Successfully converted 2 packages from Cargo.lock to bazel-out/k8-fastbuild/bin/formatted.txt
[14 / 16] JavaToolchainCompileBootClasspath external/rules_java+/toolchains/platformclasspath.jar; 0s disk-cache, processwrapper-sandbox
INFO: Found 1 target...
Target //:license.check.license_check up-to-date:
  bazel-bin/license.check.license_check
  bazel-bin/license.check.license_check.jar
INFO: Elapsed time: 28.284s, Critical Path: 2.40s
INFO: 16 processes: 12 internal, 3 processwrapper-sandbox, 1 worker.
INFO: Build completed successfully, 16 total actions
INFO: Running command line: bazel-bin/license.check.license_check ./formatted.txt <args omitted>
usage: org.eclipse.dash.licenses.cli.Main [-batch <int>] [-cd <url>]
       [-confidence <int>] [-ef <url>] [-excludeSources <sources>] [-help] [-lic
       <url>] [-project <shortname>] [-repo <url>] [-review] [-summary <file>]
       [-timeout <seconds>] [-token <token>]

github-actions · 2026-07-15T14:28:51Z

The created documentation from the pull request is available at: docu-html

lavrovvalera · 2026-07-20T15:54:27Z

+  - **SteadyTime**: Monotonic time for duration measurements and timeouts
+  - **HighResSteadyTime**: High-precision monotonic time for precise timing applications
+  - **VehicleTime**: PTP-synchronized time for distributed automotive applications requiring initialization
+- **Unified API**: Type-safe `Clock<Tag>::GetInstance().Now()` returns `ClockSnapshot<TimePoint, Status>` with atomic time + metadata reads


I'm not sure, we need to mention it here.
it is the implementtion details, not the actual fucntionality

lavrovvalera · 2026-07-20T15:55:29Z

+  - **HighResSteadyTime**: High-precision monotonic time for precise timing applications
+  - **VehicleTime**: PTP-synchronized time for distributed automotive applications requiring initialization
+- **Unified API**: Type-safe `Clock<Tag>::GetInstance().Now()` returns `ClockSnapshot<TimePoint, Status>` with atomic time + metadata reads
+- **Event Subscription**: `Subscribe<EventType>()` / `Unsubscribe<EventType>()` for status changes and PTP protocol data


it is being used currently in PTP based timebase. I havea feeling, the current formulation is missleading

not sure I understand your point but updated the wording to "timebase"

lavrovvalera · 2026-07-20T15:55:49Z

+- **Unified API**: Type-safe `Clock<Tag>::GetInstance().Now()` returns `ClockSnapshot<TimePoint, Status>` with atomic time + metadata reads
+- **Event Subscription**: `Subscribe<EventType>()` / `Unsubscribe<EventType>()` for status changes and PTP protocol data
+- **Time Infrastructure**
+  - **TimeDaemon**: Plugin-based time distribution daemon with IPC message broker


why do we need to mention here message broker?

lavrovvalera · 2026-07-20T15:56:26Z

+- **Event Subscription**: `Subscribe<EventType>()` / `Unsubscribe<EventType>()` for status changes and PTP protocol data
+- **Time Infrastructure**
+  - **TimeDaemon**: Plugin-based time distribution daemon with IPC message broker
+  - **TimeSlave**: PTP protocol implementation with offset calculation and rate adjustment


it is not the PTP protocol implementaiton only.
Could you elaborate bit more?

added more detail

lavrovvalera · 2026-07-20T15:57:00Z

+- **Time Infrastructure**
+  - **TimeDaemon**: Plugin-based time distribution daemon with IPC message broker
+  - **TimeSlave**: PTP protocol implementation with offset calculation and rate adjustment
+- **Test Utilities**: Mock backends and `ScopedClockOverride` for comprehensive testing


That is applicable to the interfaces only, but iun the full list.

Suggerstion, to update the list in general

Moved to clock domain section

lavrovvalera · 2026-07-20T16:04:21Z

-> NOTE: This is just proposal, the final decision is on module maintainer how
-> the module code needs to be built.
+```bash
+bazel test //...


here as well, suggest to specify the score and examples subfoldeers in oder to minimize the risk not to touch the filex, which should be not be run.
also add the config

lavrovvalera · 2026-07-20T16:05:03Z

-bazel test //tests/...
+**Linux AArch64**:
+```bash
+bazel build --config=time-arm64-linux //...


here and everywhere: add the sibfolders

lavrovvalera · 2026-07-20T16:05:43Z

- **Rust:** `clippy`, `rustfmt`, `Rust Unit Tests`
- **CI/CD:** GitHub Actions for automated builds and tests
+```bash
+bazel test --config=time-x86_64-linux --config=asan_ubsan_lsan --build_tests_only //...


Does the asan_ubsan_lsan donfig alrady contains the time-x86_64-linux one?

Looking at .bazelrc, I think no, it just sets sanitizer flags, debug symbols and test filters

lavrovvalera · 2026-07-20T16:07:06Z

+## 💡 Examples

- A **centralized docs structure** is planned.
+Working examples demonstrating clock usage patterns, testing approaches, and integration techniques. See [examples/](examples/) for complete usage examples.


I would believe, i nthe examples/ there is no documentation available. at lease in the root folder.
then either need to add docs there or add some usefull info and explanation here

added more detail

lavrovvalera · 2026-07-20T16:07:38Z

+│   ├── time/                    # Clock domains (SystemTime, SteadyTime, etc.)
+│   ├── time_daemon/             # Time distribution daemon
+│   ├── time_slave/              # PTP synchronization implementation
+│   └── ts_client/               # Time status utilities (internal)


it is not hte utility
it is the library to communicate with time slave

github-project-automation Bot added this to TIM - Time FT Jul 15, 2026

github-project-automation Bot moved this to In Progress in TIM - Time FT Jul 15, 2026

ryan-steel had a problem deploying to workflow-approval July 15, 2026 14:23 — with GitHub Actions Error

ryan-steel force-pushed the update-readme branch from 6979cb5 to 5d1e23d Compare July 15, 2026 14:23

ryan-steel had a problem deploying to workflow-approval July 15, 2026 14:24 — with GitHub Actions Error

docs: update readme

e8b3f0c

ryan-steel force-pushed the update-readme branch from 5d1e23d to e8b3f0c Compare July 15, 2026 14:43

ryan-steel had a problem deploying to workflow-approval July 15, 2026 14:43 — with GitHub Actions Error

ryan-steel added the documentation Improvements or additions to documentation label Jul 15, 2026

ryan-steel self-assigned this Jul 15, 2026

ryan-steel marked this pull request as ready for review July 15, 2026 14:45

retrigger CI

6fb12b9

ryan-steel had a problem deploying to workflow-approval July 15, 2026 14:53 — with GitHub Actions Error

PiotrKorkus reviewed Jul 15, 2026

View reviewed changes

Comment thread README.md Outdated

chore: update bazel registry link

ca1e097

ryan-steel requested a deployment to workflow-approval July 16, 2026 09:55 — with GitHub Actions Waiting

ryan-steel requested a review from PiotrKorkus July 16, 2026 11:21

PiotrKorkus approved these changes Jul 16, 2026

View reviewed changes

lavrovvalera reviewed Jul 20, 2026

View reviewed changes

ryan-steel requested a review from lavrovvalera July 21, 2026 09:49

Uh oh!

Conversation

ryan-steel commented Jul 15, 2026

Improvement

Description

Related ticket

Uh oh!

github-actions Bot commented Jul 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

License Check Results

Uh oh!

github-actions Bot commented Jul 15, 2026

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

github-actions Bot commented Jul 15, 2026 •

edited

Loading