diff --git a/apricot/apricot.go b/apricot/apricot.go index f4c33898d..e9a517984 100644 --- a/apricot/apricot.go +++ b/apricot/apricot.go @@ -22,6 +22,8 @@ * Intergovernmental Organization or submit itself to any jurisdiction. */ +// Package apricot implements the ALICE configuration service with templating, +// load balancing and caching capabilities on top of the configuration store. package apricot import ( diff --git a/apricot/cacheproxy/service.go b/apricot/cacheproxy/service.go index 05ea7aa94..78c2c1d92 100644 --- a/apricot/cacheproxy/service.go +++ b/apricot/cacheproxy/service.go @@ -1,3 +1,5 @@ +// Package cacheproxy provides a caching proxy implementation for the +// configuration service, optimizing detector inventory lookups. package cacheproxy import ( diff --git a/apricot/local/service.go b/apricot/local/service.go index 53e111529..827cb931b 100644 --- a/apricot/local/service.go +++ b/apricot/local/service.go @@ -22,6 +22,8 @@ * Intergovernmental Organization or submit itself to any jurisdiction. */ +// Package local implements a local configuration backend for the configuration +// service, providing direct access to the backend storage without gRPC. package local import ( diff --git a/apricot/remote/service.go b/apricot/remote/service.go index 974e604e3..a80efa1c6 100644 --- a/apricot/remote/service.go +++ b/apricot/remote/service.go @@ -22,6 +22,8 @@ * Intergovernmental Organization or submit itself to any jurisdiction. */ +// Package remote implements a remote configuration backend for the configuration +// service, accessing configuration handled by a different application via gRPC. package remote import ( diff --git a/coconut/app/constants.go b/coconut/app/constants.go index e66f78d47..2f8338da9 100644 --- a/coconut/app/constants.go +++ b/coconut/app/constants.go @@ -22,6 +22,8 @@ * Intergovernmental Organization or submit itself to any jurisdiction. */ +// Package app provides application constants and metadata for the coconut +// command line interface and its components. package app const ( diff --git a/coconut/cmd/environment.go b/coconut/cmd/environment.go index f6dcc1f58..125e947b8 100644 --- a/coconut/cmd/environment.go +++ b/coconut/cmd/environment.go @@ -24,6 +24,8 @@ //go:generate protoc -I=../../core -I=../../common --go_out=.. --go_opt=paths=source_relative --go-grpc_opt=paths=source_relative --go-grpc_out=require_unimplemented_servers=false:.. protos/o2control.proto +// Package cmd implements the command line interface for coconut, providing +// various subcommands for managing O² Control environments and configurations. package cmd import ( diff --git a/common/event/topic/topic.go b/common/event/topic/topic.go index ae2e2d262..b71936ad8 100644 --- a/common/event/topic/topic.go +++ b/common/event/topic/topic.go @@ -22,6 +22,7 @@ * Intergovernmental Organization or submit itself to any jurisdiction. */ +// Package topic defines constants and types for event system topics. package topic type Topic string diff --git a/common/event/writer.go b/common/event/writer.go index 347c0a781..b0cb571a6 100644 --- a/common/event/writer.go +++ b/common/event/writer.go @@ -22,6 +22,8 @@ * Intergovernmental Organization or submit itself to any jurisdiction. */ +// Package event provides event publishing and streaming functionality for +// O² Control components, supporting Kafka and dummy event writers. package event import ( diff --git a/common/golangmetrics/metrics.go b/common/golangmetrics/metrics.go index f1bcfabed..855faeed7 100644 --- a/common/golangmetrics/metrics.go +++ b/common/golangmetrics/metrics.go @@ -22,6 +22,8 @@ * Intergovernmental Organization or submit itself to any jurisdiction. */ +// Package golangmetrics provides Go runtime metrics collection and reporting +// functionality for monitoring system resource usage and performance. package golangmetrics import ( diff --git a/common/logger/infologger/protocols.go b/common/logger/infologger/protocols.go index cf640f4a6..0b0782052 100644 --- a/common/logger/infologger/protocols.go +++ b/common/logger/infologger/protocols.go @@ -22,6 +22,8 @@ * Intergovernmental Organization or submit itself to any jurisdiction. */ +// Package infologger provides InfoLogger protocol implementation for +// integration with the ALICE InfoLogger logging system. package infologger type protoVersion string diff --git a/common/monitoring/monitoring.go b/common/monitoring/monitoring.go index 47cf9dc2c..ca21056b9 100644 --- a/common/monitoring/monitoring.go +++ b/common/monitoring/monitoring.go @@ -22,6 +22,8 @@ * Intergovernmental Organization or submit itself to any jurisdiction. */ +// Package monitoring provides monitoring and metrics collection functionality +// for O² Control components. package monitoring import ( diff --git a/common/product/constants.go b/common/product/constants.go index 6f3c1f345..c6c981d3a 100644 --- a/common/product/constants.go +++ b/common/product/constants.go @@ -22,6 +22,8 @@ * Intergovernmental Organization or submit itself to any jurisdiction. */ +// Package product provides version information and build metadata for +// O² Control products and components. package product import ( diff --git a/common/utils/safeacks/safeacks.go b/common/utils/safeacks/safeacks.go index bace3f235..b3ff7f116 100644 --- a/common/utils/safeacks/safeacks.go +++ b/common/utils/safeacks/safeacks.go @@ -22,6 +22,8 @@ * Intergovernmental Organization or submit itself to any jurisdiction. */ +// Package safeacks provides thread-safe acknowledgment handling for managing +// communication between multiple senders and a single receiver. package safeacks import ( diff --git a/common/utils/uid/uid.go b/common/utils/uid/uid.go index 95aa79ee9..1b417a638 100644 --- a/common/utils/uid/uid.go +++ b/common/utils/uid/uid.go @@ -22,6 +22,7 @@ * Intergovernmental Organization or submit itself to any jurisdiction. */ +// Package uid provides unique identifier generation functionality. package uid import ( diff --git a/common/utils/utils.go b/common/utils/utils.go index c4702ea72..d04008ce9 100644 --- a/common/utils/utils.go +++ b/common/utils/utils.go @@ -22,6 +22,8 @@ * Intergovernmental Organization or submit itself to any jurisdiction. */ +// Package utils provides common utility functions for string manipulation, +// data conversion, and various helper operations used across O² Control components. package utils import ( diff --git a/configuration/componentcfg/componentcfg.go b/configuration/componentcfg/componentcfg.go index ca7065e7c..082464d21 100644 --- a/configuration/componentcfg/componentcfg.go +++ b/configuration/componentcfg/componentcfg.go @@ -23,6 +23,8 @@ * Intergovernmental Organization or submit itself to any jurisdiction. */ +// Package componentcfg provides component configuration management functionality, +// including query handling and template processing for O² components. package componentcfg import ( diff --git a/configuration/service.go b/configuration/service.go index ac9be5b70..534cba725 100644 --- a/configuration/service.go +++ b/configuration/service.go @@ -22,6 +22,8 @@ * Intergovernmental Organization or submit itself to any jurisdiction. */ +// Package configuration provides interfaces and implementations for managing +// runtime configuration of O² Control components and detectors. package configuration import ( diff --git a/configuration/template/fields.go b/configuration/template/fields.go index 3a0114fe8..43a0f8441 100644 --- a/configuration/template/fields.go +++ b/configuration/template/fields.go @@ -22,6 +22,8 @@ * Intergovernmental Organization or submit itself to any jurisdiction. */ +// Package template provides template processing functionality for configuration +// files, including custom field handling and template execution. package template import ( diff --git a/core/core.go b/core/core.go index d6a2cebf2..6919cb45c 100644 --- a/core/core.go +++ b/core/core.go @@ -22,6 +22,8 @@ * Intergovernmental Organization or submit itself to any jurisdiction. */ +// Package core implements the main AliECS core functionality including +// the gRPC API server, environment management, and integration with various services. package core import ( diff --git a/core/integration/bookkeeping/plugin.go b/core/integration/bookkeeping/plugin.go index 3cd605f4a..476fdb1be 100644 --- a/core/integration/bookkeeping/plugin.go +++ b/core/integration/bookkeeping/plugin.go @@ -31,6 +31,8 @@ //go:generate protoc --go_out=. --go_opt=paths=source_relative --go-grpc_opt=paths=source_relative --go-grpc_out=require_unimplemented_servers=false:. protos/run.proto //go:generate protoc --go_out=. --go_opt=paths=source_relative --go-grpc_opt=paths=source_relative --go-grpc_out=require_unimplemented_servers=false:. protos/lhcFill.proto +// Package bookkeeping provides integration with the ALICE Bookkeeping system +// for tracking runs and retrieving LHC fill information. package bookkeeping import ( diff --git a/core/integration/ccdb/plugin.go b/core/integration/ccdb/plugin.go index 5ab1d9aa2..b420e3be9 100644 --- a/core/integration/ccdb/plugin.go +++ b/core/integration/ccdb/plugin.go @@ -22,6 +22,8 @@ * Intergovernmental Organization or submit itself to any jurisdiction. */ +// Package ccdb provides integration with the Condition and Calibration Database (CCDB) +// for creating and managing General Run Parameters (GRP) objects. package ccdb import ( diff --git a/core/integration/dcs/plugin.go b/core/integration/dcs/plugin.go index 9a5b253ef..e6d8485f9 100644 --- a/core/integration/dcs/plugin.go +++ b/core/integration/dcs/plugin.go @@ -24,6 +24,8 @@ //go:generate protoc --go_out=. --go_opt=paths=source_relative --go-grpc_opt=paths=source_relative --go-grpc_out=require_unimplemented_servers=false:. protos/dcs.proto +// Package dcs provides integration with the ALICE Detector Control System (DCS) +// for managing detector operations and state compatibility checks. package dcs import ( diff --git a/core/integration/ddsched/plugin.go b/core/integration/ddsched/plugin.go index ce3f88f3c..917b1a6e5 100644 --- a/core/integration/ddsched/plugin.go +++ b/core/integration/ddsched/plugin.go @@ -24,6 +24,8 @@ //go:generate protoc --go_out=. --go_opt=paths=source_relative --go-grpc_opt=paths=source_relative --go-grpc_out=require_unimplemented_servers=false:. protos/ddsched.proto +// Package ddsched provides integration with the Data Distribution (DD) scheduler +// for managing the pool of FLPs participating in data taking operations. package ddsched import ( diff --git a/core/integration/odc/plugin.go b/core/integration/odc/plugin.go index b1550e952..ba50a8919 100644 --- a/core/integration/odc/plugin.go +++ b/core/integration/odc/plugin.go @@ -24,6 +24,8 @@ //go:generate protoc --go_out=. --go_opt=paths=source_relative --go-grpc_opt=paths=source_relative --go-grpc_out=require_unimplemented_servers=false:. protos/odc.proto +// Package odc provides integration with the Online Device Control (ODC) system +// for managing the ALICE event processing farm during data taking and offline processing. package odc import ( diff --git a/core/integration/plugin.go b/core/integration/plugin.go index 2b4f73444..12bd01fbc 100644 --- a/core/integration/plugin.go +++ b/core/integration/plugin.go @@ -22,6 +22,8 @@ * Intergovernmental Organization or submit itself to any jurisdiction. */ +// Package integration provides the plugin system for integrating O² Control +// with external services like DCS, Bookkeeping, ODC, and other ALICE systems. package integration import ( diff --git a/core/integration/testplugin/plugin.go b/core/integration/testplugin/plugin.go index 19d96e810..fe545a247 100644 --- a/core/integration/testplugin/plugin.go +++ b/core/integration/testplugin/plugin.go @@ -22,6 +22,8 @@ * Intergovernmental Organization or submit itself to any jurisdiction. */ +// Package testplugin provides a test integration plugin that serves as an example +// and is used for testing the plugin system functionality. package testplugin import ( diff --git a/core/integration/trg/plugin.go b/core/integration/trg/plugin.go index c070eadcb..2ebdc84d7 100644 --- a/core/integration/trg/plugin.go +++ b/core/integration/trg/plugin.go @@ -25,6 +25,7 @@ //go:generate protoc --go_out=. --go_opt=paths=source_relative --go-grpc_opt=paths=source_relative --go-grpc_out=require_unimplemented_servers=false:. protos/ctpecs.proto +// Package trg provides integration with the ALICE trigger system. package trg import ( diff --git a/core/integration/trg/trgutil.go b/core/integration/trg/trgutil.go index dca8b9a3f..c1a705d0b 100644 --- a/core/integration/trg/trgutil.go +++ b/core/integration/trg/trgutil.go @@ -22,6 +22,7 @@ * Intergovernmental Organization or submit itself to any jurisdiction. */ +// Package trg provides integration with the ALICE trigger system. package trg import ( diff --git a/core/repos/sshrepo.go b/core/repos/sshrepo.go index 1ad7e0702..a47f3aaa5 100644 --- a/core/repos/sshrepo.go +++ b/core/repos/sshrepo.go @@ -22,6 +22,8 @@ * Intergovernmental Organization or submit itself to any jurisdiction. */ +// Package repos provides repository management functionality for accessing +// and synchronizing Git repositories containing workflow templates and configurations. package repos import ( diff --git a/core/repos/varsource/varsource.go b/core/repos/varsource/varsource.go index a7e3b85c1..8551ed739 100644 --- a/core/repos/varsource/varsource.go +++ b/core/repos/varsource/varsource.go @@ -22,6 +22,8 @@ * Intergovernmental Organization or submit itself to any jurisdiction. */ +// Package varsource provides variable source management functionality for +// tracking the origin and precedence of configuration variables in workflows. package varsource type Source int diff --git a/core/task/channel/channel.go b/core/task/channel/channel.go index 1e05e5123..d79496f6b 100644 --- a/core/task/channel/channel.go +++ b/core/task/channel/channel.go @@ -22,6 +22,8 @@ * Intergovernmental Organization or submit itself to any jurisdiction. */ +// Package channel provides functionality for managing task communication channels, +// including inbound and outbound channel configuration and message routing. package channel import ( diff --git a/core/task/schedutil/mesosutil.go b/core/task/schedutil/mesosutil.go index a6bff6201..6db3d511b 100644 --- a/core/task/schedutil/mesosutil.go +++ b/core/task/schedutil/mesosutil.go @@ -25,6 +25,8 @@ * Intergovernmental Organization or submit itself to any jurisdiction. */ +// Package schedutil provides scheduler utility functions for Apache Mesos +// integration, including resource management and task scheduling helpers. package schedutil import ( diff --git a/core/task/sm/machine.go b/core/task/sm/machine.go index 7287714ef..81546c9c2 100644 --- a/core/task/sm/machine.go +++ b/core/task/sm/machine.go @@ -22,6 +22,8 @@ * Intergovernmental Organization or submit itself to any jurisdiction. */ +// Package sm provides state machine functionality for task lifecycle management, +// including state transitions and event handling. package sm type Transition struct { diff --git a/core/task/taskclass/port/range.go b/core/task/taskclass/port/range.go index 895ba97ae..caf335b23 100644 --- a/core/task/taskclass/port/range.go +++ b/core/task/taskclass/port/range.go @@ -22,6 +22,8 @@ * Intergovernmental Organization or submit itself to any jurisdiction. */ +// Package port provides port range management functionality for task +// communication, including port range parsing and validation. package port import ( diff --git a/core/task/taskclass/resourcelimits.go b/core/task/taskclass/resourcelimits.go index 5b62f84f2..37916e843 100644 --- a/core/task/taskclass/resourcelimits.go +++ b/core/task/taskclass/resourcelimits.go @@ -22,6 +22,8 @@ * Intergovernmental Organization or submit itself to any jurisdiction. */ +// Package taskclass provides task class definitions and resource management +// for different types of tasks. package taskclass import "strconv" diff --git a/core/task/taskop/messagetype.go b/core/task/taskop/messagetype.go index 92e97da06..fa2d18a46 100644 --- a/core/task/taskop/messagetype.go +++ b/core/task/taskop/messagetype.go @@ -22,6 +22,8 @@ * Intergovernmental Organization or submit itself to any jurisdiction. */ +// Package taskop provides task operation types and message handling functionality +// for controlling task lifecycle and communication. package taskop import ( diff --git a/core/the/eventwriter.go b/core/the/eventwriter.go index 064f025fc..bf7d76175 100644 --- a/core/the/eventwriter.go +++ b/core/the/eventwriter.go @@ -22,6 +22,8 @@ * Intergovernmental Organization or submit itself to any jurisdiction. */ +// Package the provides global event handling and state management for +// the core system, including event writers and system-wide notifications. package the import ( diff --git a/core/workflow/callable/utils.go b/core/workflow/callable/utils.go index df2eae902..02e579e2c 100644 --- a/core/workflow/callable/utils.go +++ b/core/workflow/callable/utils.go @@ -1,3 +1,5 @@ +// Package callable provides utility functions for workflow callable operations, +// including timeout handling and trigger expression parsing. package callable import ( diff --git a/executor/executable/task.go b/executor/executable/task.go index 0376fe8f3..e23b56394 100644 --- a/executor/executable/task.go +++ b/executor/executable/task.go @@ -22,6 +22,8 @@ * Intergovernmental Organization or submit itself to any jurisdiction. */ +// Package executable provides platform-specific executable management functionality +// for running and controlling tasks in the executor environment. package executable import ( diff --git a/executor/executorcmd/nopb/jsoncodec.go b/executor/executorcmd/nopb/jsoncodec.go index a6abbff16..b4c69c024 100644 --- a/executor/executorcmd/nopb/jsoncodec.go +++ b/executor/executorcmd/nopb/jsoncodec.go @@ -22,6 +22,8 @@ * Intergovernmental Organization or submit itself to any jurisdiction. */ +// Package nopb provides non-protobuf encoding functionality including +// JSON codec implementations for gRPC communication. package nopb import ( diff --git a/executor/executorutil/executorutil.go b/executor/executorutil/executorutil.go index 7b28cef29..5dbbb0961 100644 --- a/executor/executorutil/executorutil.go +++ b/executor/executorutil/executorutil.go @@ -22,6 +22,8 @@ * Intergovernmental Organization or submit itself to any jurisdiction. */ +// Package executorutil provides utility functions for the executor, +// including resource management and task execution helpers. package executorutil import ( diff --git a/occ/peanut/peanut.go b/occ/peanut/peanut.go index 8493ea11f..4e6f4d5f5 100644 --- a/occ/peanut/peanut.go +++ b/occ/peanut/peanut.go @@ -22,6 +22,8 @@ * Intergovernmental Organization or submit itself to any jurisdiction. */ +// Package peanut implements a process execution and control utility for +// OCClib-based O² processes, providing debugging and development support. package peanut import (