Skip to content

docs(module): fix missing baselibs components in mod includes - #618

Merged
4og merged 5 commits into
mainfrom
fix-mod-baselibs-includes
Sep 23, 2026
Merged

docs(module): fix missing baselibs components in mod includes#618
4og merged 5 commits into
mainfrom
fix-mod-baselibs-includes

Conversation

@antonkri

@antonkri antonkri commented Sep 23, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Why

The mod:: (mod__baselibs) and mod_view_sta:: (mod_view_sta__baselibs__baselibs) definitions in docs/module/index.rst only listed 10 of the 17 existing comp__baselibs_* components in their :includes:. Since docs/verification_report/module_verification_report.rst now generates its content from these includes (via :post_template:), missing components also meant they were silently missing from the generated Baselibs module verification report.

What changed

  • docs/module/index.rst: added the 7 missing components (comp__baselibs_containers_rust, comp__baselibs_flatbuffers, comp__baselibs_hash, comp__baselibs_json_wrapper, comp__baselibs_nlohman_json, comp__baselibs_vajson, comp__baselibs_static_reflection) to the :includes: of both mod:: and mod_view_sta::.
  • docs/module/index.rst: wrapped the long :includes: lists across multiple aligned lines for readability.
  • MODULE.bazel / MODULE.bazel.lock: bumped score_docs_as_code to the published 8.2.0 release and removed the git_override pin to a specific commit.
  • docs/verification_report/module_verification_report.rst: switched the Baselibs module verification report to use :post_template: module_verification_report (from score_docs_as_code) instead of the hand-written report text, so it is generated automatically from the module's :includes:. Also sets :report_version: v1.0.

Commits

  1. docs(module): add missing baselibs components to mod_view_sta includes
  2. docs(module): add missing baselibs components to mod includes
  3. docs(module): wrap long :includes: lists across multiple aligned lines
  4. build: use score_docs_as_code 8.2.0 release instead of pinned commit
  5. docs(verification_report): switch module verification report to post_template

@github-project-automation github-project-automation Bot moved this to In Progress in BAS - Baselibs FT Sep 23, 2026
@github-actions github-actions Bot added documentation Improvements or additions to documentation bazel Bazel and Starlark build files labels Sep 23, 2026
@github-actions

github-actions Bot commented Sep 23, 2026

Copy link
Copy Markdown
Contributor

Documentation preview for this pull request is available at:
pr-618: https://eclipse-score.github.io/baselibs/pr-618/

@github-project-automation github-project-automation Bot moved this from In Progress to On Hold in BAS - Baselibs FT Sep 23, 2026
@4og
4og enabled auto-merge September 23, 2026 07:39
@4og
4og added this pull request to the merge queue Sep 23, 2026
Merged via the queue into main with commit 9216215 Sep 23, 2026
27 checks passed
@4og
4og deleted the fix-mod-baselibs-includes branch September 23, 2026 08:24
@github-project-automation github-project-automation Bot moved this from On Hold to Done in BAS - Baselibs FT Sep 23, 2026
@antonkri antonkri mentioned this pull request Sep 23, 2026
Closed
antonkri added a commit to eclipse-score/reference_integration that referenced this pull request Sep 23, 2026
@antonkri
chore: update baselibs to latest main, drop rename-manual-verificatio…
076a7da 
…n-report patch

Baselibs eclipse-score/baselibs#618 fixed the module_verification_report
post_template to include all components and switched baselibs' own
docs/verification_report/module_verification_report.rst to generate its
report via the shared module_verification_report post_template, keeping
the id doc__baselibs_verification_report (the template derives the module
id by stripping doc__/_verification_report from the need's own id, so this
id is now load-bearing).

patches/baselibs/005-rename-manual-verification-report-id.patch is no
longer compatible with that: reapplying it would rename the id to
doc__baselibs_manual_verification_report, which the template would then
misparse as module id baselibs_manual, producing an empty report.

- Bump score_baselibs known_good pin to 9216215f3a8468f3487884b472e1f325ef36f92b (main after #618).
- Drop patch 005 from known_good.json and regenerate bazel_common/score_modules_target_sw.MODULE.bazel.
- Simplify docs/verification_report/modules/baselibs/baselibs_verification_report.rst: it no longer
  redeclares a document with the (now colliding) id, it just links to the report baselibs itself
  contributes via its docs bundle mount.
- Refresh MODULE.bazel.lock via 'bazel mod deps --lockfile_mode=update'.
@antonkri antonkri mentioned this pull request Sep 23, 2026
Merged
antonkri added a commit to eclipse-score/logging that referenced this pull request Sep 23, 2026
@antonkri
docs(verification_report): use post-template
2026533 
Replace the manual dummy content in module_verification_report.rst with
the score_docs_as_code post_template mechanism (module_verification_report),
matching the approach used in eclipse-score/baselibs#618.
antonkri added a commit to eclipse-score/logging that referenced this pull request Sep 24, 2026
@antonkri
docs(verification_report): use automated post-template for module ver…
b4f272b 
…ification report (#332)

* docs(verification_report): use post-template

Replace the manual dummy content in module_verification_report.rst with
the score_docs_as_code post_template mechanism (module_verification_report),
matching the approach used in eclipse-score/baselibs#618.

* docs(module): rename mod id to mod__logging

The module_verification_report post-template derives the module id from
the report's document id (doc__logging_verification_report -> mod__logging),
so the mod Need must use that exact id for the report to find and list the
module's components. Rename mod__logging_repo -> mod__logging accordingly.

* chore(deps): bump score_docs_as_code to 8.2.0

8.2.0 brings the updated module_verification_report template (report_version
scoping via valid_from) and the new platform_verification_report template.
report_version is intentionally left unset on the logging report, which keeps
it unscoped so all components and requirements are listed.
antonkri added a commit to eclipse-score/reference_integration that referenced this pull request Sep 28, 2026
@4og @antonkri
Update score_baselibs commit hash to latest version (#355)
f9aa17d 
* Update score_baselibs commit hash to latest version

* com: add migration patch for baselibs Rust targets

* persistency: add migration patch for baselibs Rust targets

* build: allow Bazel to continue building after errors

* lifecycle: add migration patch for baselibs Rust targets and update Bazel configuration

* chore: update baselibs to latest main, drop rename-manual-verification-report patch

Baselibs eclipse-score/baselibs#618 fixed the module_verification_report
post_template to include all components and switched baselibs' own
docs/verification_report/module_verification_report.rst to generate its
report via the shared module_verification_report post_template, keeping
the id doc__baselibs_verification_report (the template derives the module
id by stripping doc__/_verification_report from the need's own id, so this
id is now load-bearing).

patches/baselibs/005-rename-manual-verification-report-id.patch is no
longer compatible with that: reapplying it would rename the id to
doc__baselibs_manual_verification_report, which the template would then
misparse as module id baselibs_manual, producing an empty report.

- Bump score_baselibs known_good pin to 9216215f3a8468f3487884b472e1f325ef36f92b (main after #618).
- Drop patch 005 from known_good.json and regenerate bazel_common/score_modules_target_sw.MODULE.bazel.
- Simplify docs/verification_report/modules/baselibs/baselibs_verification_report.rst: it no longer
  redeclares a document with the (now colliding) id, it just links to the report baselibs itself
  contributes via its docs bundle mount.
- Refresh MODULE.bazel.lock via 'bazel mod deps --lockfile_mode=update'.

* docs(verification_report): link baselibs module report directly, drop wrapper

Remove docs/verification_report/modules/baselibs/, which only redeclared
a redundant document need. Link modules/index.rst directly to
/modules/score_baselibs/verification_report/module_verification_report,
the report baselibs itself contributes via its docs bundle mount, so
clicking "Baselibs" jumps straight to it instead of an intermediate
wrapper page.

* chore: drop stale buildifier_prebuilt 8.2.0.2 entries from MODULE.bazel.lock

bazel mod tidy in CI removes the obsolete registryFileHashes entries for
buildifier_prebuilt/8.2.0.2, which are no longer part of the resolved
dependency graph. Sync the lockfile to fix the bzlmod-lock-check.

* fix(config_management): follow the string_manipulation move in baselibs

baselibs 0bde8113d ("memory: remove deprecated string manipulation
shims") dropped the forwarding headers that still lived under
score/memory; string_literal, string_comparison_adaptor and
split_string_view have been in //score/string_manipulation since
980a5510d. config_management never followed, so against the baselibs
commit this branch pins, config_provider_impl.h fails to compile with

  fatal error: score/memory/string_comparison_adaptor.h: No such file

Point the include at the new path and add the Bazel dependency
explicitly. It was only reachable transitively via
score/json/internal/model before, which is not something a header
should rely on.

Upstream has nothing to wait for: neither main nor any open PR or
branch in eclipse-score/config_management touches this header, so the
patch stays until the module migrates itself.

While here, drop the duplicate "bazel_patches" key in the module's
known_good.json entry - the later one silently won.

* fix(logging): follow the string_manipulation and log_rust moves in baselibs

Two independent baselibs restructurings caught up with score_logging at
the same time:

  980a5510d  string_literal moved to //score/string_manipulation
  9c2a4481b  Rust components moved from //src/log to //score/log_rust
  0bde8113d  the deprecated score/memory shims were finally removed

Against the baselibs commit this branch pins, that leaves four dead
labels:

  score/datarouter/error            -> score/memory:string_literal
  score_log_bridge (2x)             -> src/log/score_log
  score_log_bridge_cpp_init         -> src/log/score_log

The first one breaks the x86_64 Linux and QNX8 image builds, the Rust
ones abort analysis of the whole module, which is why score_logging
reported zero executed tests.

The same three files are already rewritten this way in
eclipse-score/logging#271, but that is a syslog-backend feature PR tied
to baselibs#502, not a migration, and it is behind main. Nothing else
upstream addresses this, so carry the change here until the module
migrates on its own.

* fix(logging): regenerate the baselibs migration patch for the new pin

The merge with main brought in #367, which moves score_logging from
c8e85fd8 to b4f272b0. The patch still applied there, but with the two
Rust hunks drifting 10 and 11 lines. Regenerate it against b4f272b0 so
it sits on its context exactly.

No content change: the same four labels are rewritten.

---------

Co-authored-by: Anton Krivoborodov <anton.krivoborodov@bmw.de>
Co-authored-by: Anton Krivoborodov <63401640+antonkri@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@4og 4og 4og approved these changes
@fbaeuerle fbaeuerle Awaiting requested review from fbaeuerle fbaeuerle is a code owner
@aschemmel-tech aschemmel-tech Awaiting requested review from aschemmel-tech aschemmel-tech is a code owner
@pawelrutkaq pawelrutkaq Awaiting requested review from pawelrutkaq pawelrutkaq is a code owner
@arkjedrz arkjedrz Awaiting requested review from arkjedrz arkjedrz is a code owner

Assignees

No one assigned

Labels

bazel Bazel and Starlark build files documentation Improvements or additions to documentation

Projects

BAS - Baselibs FT
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@antonkri @4og