Skip to content

migrate time_slave detailed design to doxygen - #193

Open
ryan-steel wants to merge 11 commits into
eclipse-score:mainfrom
etas-contrib:migrate-time_slave-detailed-design-to-doxygen
Open

migrate time_slave detailed design to doxygen#193
ryan-steel wants to merge 11 commits into
eclipse-score:mainfrom
etas-contrib:migrate-time_slave-detailed-design-to-doxygen

Conversation

@ryan-steel

@ryan-steel ryan-steel commented Aug 27, 2026

Copy link
Copy Markdown
Contributor

Description

Migrates the detailed design docs to doxygen to match process description guidelines which state that detailed design documentation belongs in code rather than separate design artifacts.

Related ticket

Part of #88

@github-actions

github-actions Bot commented Aug 27, 2026

Copy link
Copy Markdown

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: 5acafdbb-5cf9-4c29-a399-0f1213f9e547
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
WARNING: For repository 'platforms', the root module requires module version platforms@1.0.0, but got platforms@1.1.0 in the resolved dependency graph. Please update the version in your MODULE.bazel or set --check_direct_dependencies=off
WARNING: For repository 'score_platform', the root module requires module version score_platform@0.7.1, but got score_platform@0.7.2 in the resolved dependency graph. Please update the version in your MODULE.bazel or set --check_direct_dependencies=off
WARNING: For repository 'rules_oci', the root module requires module version rules_oci@2.2.7, but got rules_oci@2.3.0 in the resolved dependency graph. Please update the version in your MODULE.bazel or set --check_direct_dependencies=off
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Loading: 
Loading: 3 packages loaded
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 (91 packages loaded, 10 targets configured)

Analyzing: target //:license-check (148 packages loaded, 1972 targets configured)

Analyzing: target //:license-check (160 packages loaded, 5551 targets configured)

Analyzing: target //:license-check (161 packages loaded, 8501 targets configured)

Analyzing: target //:license-check (171 packages loaded, 9397 targets configured)

Analyzing: target //:license-check (172 packages loaded, 9417 targets configured)

Analyzing: target //:license-check (172 packages loaded, 9417 targets configured)

Analyzing: target //:license-check (172 packages loaded, 9417 targets configured)

Analyzing: target //:license-check (173 packages loaded, 9417 targets configured)

Analyzing: target //:license-check (175 packages loaded, 11305 targets configured)

INFO: Analyzed target //:license-check (177 packages loaded, 11555 targets configured).
[6 / 16] [Prepa] Creating source manifest for @@score_tooling+//dash/tool/formatters:dash_format_converter [for tool]
INFO: From Generating Dash formatted dependency file ...:
INFO: Successfully converted 2 packages from Cargo.lock to bazel-out/k8-fastbuild/bin/formatted.txt
[13 / 16] JavaToolchainCompileClasses external/rules_java+/toolchains/platformclasspath_classes; 0s disk-cache, processwrapper-sandbox
[15 / 16] Building license.check.license_check.jar (); 0s disk-cache, multiplex-worker
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: 32.145s, Critical Path: 2.68s
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>]

@ryan-steel
ryan-steel force-pushed the migrate-time_slave-detailed-design-to-doxygen branch from 7ee20a5 to 055bd61 Compare August 27, 2026 11:17
@ryan-steel
ryan-steel force-pushed the migrate-time_slave-detailed-design-to-doxygen branch from 055bd61 to e4959db Compare August 27, 2026 12:26
Comment thread score/time_slave/docs/detailed_design/index.rst
Comment thread score/time_slave/src/gptp/details/pdelay_measurer.h Outdated
Comment thread score/time_slave/src/gptp/details/pdelay_measurer.h
Comment thread score/time_slave/src/gptp/details/clock_util.h
@ryan-steel
ryan-steel force-pushed the migrate-time_slave-detailed-design-to-doxygen branch from e4959db to 46ec7c1 Compare August 27, 2026 15:22
@ryan-steel
ryan-steel marked this pull request as ready for review September 1, 2026 13:52

@LudwigWeise LudwigWeise left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One small thing here...

Comment thread score/time_slave/src/application/time_slave.h

@LudwigWeise LudwigWeise left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Comment thread score/time_slave/docs/detailed_design/index.rst Outdated
Comment thread score/time_slave/docs/detailed_design/index.rst Outdated
Comment thread score/time_slave/src/gptp/gptp_engine.h Outdated
Comment thread score/time_slave/docs/detailed_design/index.rst Outdated
Comment thread score/time_slave/docs/detailed_design/index.rst Outdated

@BjoernAtBosch BjoernAtBosch left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: In Progress

Development

Successfully merging this pull request may close these issues.

3 participants