Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
33 changes: 31 additions & 2 deletions BUILD
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@
# *******************************************************************************

load("@rules_python//python:pip.bzl", "compile_pip_requirements")
load("@score_docs_as_code//:docs.bzl", "docs")
load("@score_docs_as_code//:bzl/bundle_rules.bzl", "bundle_source_files")
load("@score_docs_as_code//:docs.bzl", "docs", "docs_bundle")
load("@score_tooling//:defs.bzl", "copyright_checker", "dash_license_checker", "setup_starpls")
load("@score_tooling//third_party/format:macros.bzl", "use_format_targets")
load("//:project_config.bzl", "PROJECT_CONFIG")
Expand Down Expand Up @@ -108,6 +109,26 @@ use_format_targets(languages = [
exports_files(["MODULE.bazel"])

# Docs
_IS_ROOT_MODULE = repository_name() == "@"

bundle_source_files(
name = "platform_docs_sources",
bundle = "@score_platform//:docs_bundle",
)

genrule(
name = "platform_glossary_rst",
srcs = [":platform_docs_sources"],
outs = ["platform_glossary/glossary.rst"],
cmd = "cp $$(printf '%s\\n' $(SRCS) | grep '/docs/features/lifecycle/glossary[.]rst$$') $@",
)

docs_bundle(
name = "platform_glossary",
srcs = [":platform_glossary_rst"],
entry_doc = "glossary",
)

docs(
bundles = [
{
Expand All @@ -118,7 +139,15 @@ docs(
"bundle": "//score/health_monitor:docs",
"mount_at": "components/health_monitor",
},
],
] + ([
# Glossary is located in score_platform but we also need to
# avoid duplication during integration in ref_int repository
{
"attach_to": "features/lifecycle/index",
"bundle": ":platform_glossary",
"mount_at": "features/lifecycle",
},
] if _IS_ROOT_MODULE else []),
external_needs = [
"@score_platform//:needs_json", # This allows linking to feature requirements.
"@score_process_description//:needs_json", # This allows linking to requirements (wp__requirements_comp, etc.) from the process_description repository.
Expand Down
151 changes: 0 additions & 151 deletions docs/features/lifecycle/glossary.rst

This file was deleted.

54 changes: 54 additions & 0 deletions docs/features/lifecycle/glossary_detailed.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
..
# *******************************************************************************
# Copyright (c) 2025 Contributors to the Eclipse Foundation
#
# See the NOTICE file(s) distributed with this work for additional
# information regarding copyright ownership.
#
# This program and the accompanying materials are made available under the
# terms of the Apache License Version 2.0 which is available at
# https://www.apache.org/licenses/LICENSE-2.0
#
# SPDX-License-Identifier: Apache-2.0
# *******************************************************************************

Glossary
========

.. glossary::
Lifecycle Interface
Interface to report :term:`readiness <Ready State>` of a process to the
:term:`Launch Manager`.

Component failure
A state when the component has failed to reach its :term:`Ready Condition`, a running component has terminated abnormally or its supervision failed.

UID
User Identifier - a unique number assigned to each user on a Unix-like operating system.

GID
Group Identifier - a unique number assigned to each group on a Unix-like operating system.

Working Directory
The current directory from which a process is executed, also known as CWD (Current Working Directory).

File Descriptor
A handle used by a process to access files or other input/output resources.

Procmgr
Process Manager - a QNX system component that manages process creation and execution.

ASLR
Address Space Layout Randomization - a security technique that randomizes the memory layout of processes.

QNX
A real-time operating system commonly used in embedded systems.

DSS
Device Safe State - a safe operational state that a system can enter during failures.

DAG
Directed Acyclic Graph - a data structure used to represent dependencies between processes.

Fallback Run Target
A designated Run Target that the system can switch to in case the current active Run Target resp. one of its components fails.
1 change: 1 addition & 0 deletions docs/features/lifecycle/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,3 +33,4 @@ For the main feature description and requirements, see the belonging Feature in
safety_planning/index
security_planning/index
glossary
glossary_detailed
Loading