Skip to content

docs: Add documentation metadata and revision history (#65) #68

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
basheerFZ merged 2 commits into from
May 13, 2026
Merged

docs: Add documentation metadata and revision history (#65) #68

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3507f13
docs: add standardized metadata headers and revision history to docum…
LGSI-KarumuriHari May 13, 2026
59db1ff
docs: update document status to draft and revise metadata for LLD doc…
LGSI-KarumuriHari May 13, 2026
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
16 changes: 16 additions & 0 deletions doc/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,22 @@

# timpani Documentation Guide

**Document Information:**
- **Issuing Author:** Eclipse timpani Team
- **Configuration ID:** timpani-doc-index
- **Document Status:** Published
- **Last Updated:** 2026-05-13

---

## Revision History

| Version | Date | Comment | Author | Approver |
|---------|------|---------|--------|----------|
| 0.0a | 2026-05-13 | Initial documentation guide | Eclipse timpani Team | - |

---

Comment thread
LGSI-KarumuriHari marked this conversation as resolved.
**Last Updated:** May 12, 2026
**Project:** Eclipse timpani (Rust Migration)
**Version:** Milestone 1 & 2 (gRPC Integration)
Expand Down
17 changes: 17 additions & 0 deletions doc/architecture/LLD/timpani-n/01-initialization-main.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,23 @@

# LLD: Initialization & Main Entry Point

**Document Information:**
- **Issuing Author:** Eclipse timpani Team
- **Configuration ID:** timpani-n-lld-01
- **Document Status:** Draft
- **Last Updated:** 2026-05-13

---

## Revision History

| Version | Date | Comment | Author | Approver |
|---------|------|---------|--------|----------|
| 0.0b | 2026-05-13 | Updated documentation metadata and standards compliance | LGSI-KarumuriHari | - |
| 0.0a | 2026-02-24 | Initial LLD document creation | Eclipse timpani Team | - |

---
Comment thread
LGSI-KarumuriHari marked this conversation as resolved.

**Component Type:** Application Entry Point
**Responsibility:** Program initialization, main execution loop coordination, graceful shutdown
**Status:** 🔄 Partially Migrated (C → Rust)
Expand Down
17 changes: 17 additions & 0 deletions doc/architecture/LLD/timpani-n/02-configuration-management.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,23 @@

# LLD: Configuration Management

**Document Information:**
- **Issuing Author:** Eclipse timpani Team
- **Configuration ID:** timpani-n-lld-02
- **Document Status:** Draft
- **Last Updated:** 2026-05-13

---
Comment thread
LGSI-KarumuriHari marked this conversation as resolved.

## Revision History

| Version | Date | Comment | Author | Approver |
|---------|------|---------|--------|----------|
| 0.0b | 2026-05-13 | Updated documentation metadata and standards compliance | LGSI-KarumuriHari | - |
| 0.0a | 2026-02-24 | Initial LLD document creation | Eclipse timpani Team | - |

---

**Component Type:** Configuration System
**Responsibility:** CLI parsing, configuration validation, defaults management
**Status:** ✅ Complete in Rust
Expand Down
17 changes: 17 additions & 0 deletions doc/architecture/LLD/timpani-n/03-time-trigger-core.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,23 @@

# LLD: Time Trigger Core

**Document Information:**
- **Issuing Author:** Eclipse timpani Team
- **Configuration ID:** timpani-n-lld-03
- **Document Status:** Draft
- **Last Updated:** 2026-05-13

---

## Revision History

| Version | Date | Comment | Author | Approver |
|---------|------|---------|--------|----------|
| 0.0b | 2026-05-13 | Updated documentation metadata and standards compliance | LGSI-KarumuriHari | - |
| 0.0a | 2026-02-24 | Initial LLD document creation | Eclipse timpani Team | - |

---

Comment thread
LGSI-KarumuriHari marked this conversation as resolved.
**Component Type:** Core Runtime Engine
**Responsibility:** Event loop, hyperperiod management, timer coordination
**Status:** ⏸️ Not Started in Rust (C implementation documented)
Expand Down
17 changes: 17 additions & 0 deletions doc/architecture/LLD/timpani-n/04-task-management.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,23 @@

# LLD: Task Management

**Document Information:**
- **Issuing Author:** Eclipse timpani Team
- **Configuration ID:** timpani-n-lld-04
- **Document Status:** Draft
- **Last Updated:** 2026-05-13

---

## Revision History

| Version | Date | Comment | Author | Approver |
|---------|------|---------|--------|----------|
| 0.0b | 2026-05-13 | Updated documentation metadata and standards compliance | LGSI-KarumuriHari | - |
| 0.0a | 2026-02-24 | Initial LLD document creation | Eclipse timpani Team | - |

---

Comment thread
LGSI-KarumuriHari marked this conversation as resolved.
**Component Type:** Task Lifecycle Management
**Responsibility:** Task list management, activation scheduling, state tracking
**Status:** ⏸️ Not Started in Rust
Expand Down
17 changes: 17 additions & 0 deletions doc/architecture/LLD/timpani-n/05-realtime-scheduling.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,23 @@

# LLD: Real-Time Scheduling

**Document Information:**
- **Issuing Author:** Eclipse timpani Team
- **Configuration ID:** timpani-n-lld-05
- **Document Status:** Draft
- **Last Updated:** 2026-05-13

---

## Revision History

| Version | Date | Comment | Author | Approver |
|---------|------|---------|--------|----------|
| 0.0b | 2026-05-13 | Updated documentation metadata and standards compliance | LGSI-KarumuriHari | - |
| 0.0a | 2026-02-24 | Initial LLD document creation | Eclipse timpani Team | - |

---

Comment thread
LGSI-KarumuriHari marked this conversation as resolved.
**Component Type:** RT Scheduling Control
**Responsibility:** CPU affinity, RT priority, sched_setattr() syscalls
**Status:** ⏸️ Not Started in Rust
Expand Down
17 changes: 17 additions & 0 deletions doc/architecture/LLD/timpani-n/06-signal-handling.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,23 @@

# LLD: Signal Handling

**Document Information:**
- **Issuing Author:** Eclipse timpani Team
- **Configuration ID:** timpani-n-lld-06
- **Document Status:** Draft
- **Last Updated:** 2026-05-13

---

## Revision History

| Version | Date | Comment | Author | Approver |
|---------|------|---------|--------|----------|
| 0.0b | 2026-05-13 | Updated documentation metadata and standards compliance | LGSI-KarumuriHari | - |
| 0.0a | 2026-02-24 | Initial LLD document creation | Eclipse timpani Team | - |

---

Comment thread
LGSI-KarumuriHari marked this conversation as resolved.
**Component Type:** Signal Management
**Responsibility:** SIGALRM handlers, task signal delivery, shutdown signals
**Status:** ⏸️ Not Started in Rust
Expand Down
17 changes: 17 additions & 0 deletions doc/architecture/LLD/timpani-n/07-ebpf-monitoring.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,23 @@

# LLD: eBPF Monitoring System

**Document Information:**
- **Issuing Author:** Eclipse timpani Team
- **Configuration ID:** timpani-n-lld-07
- **Document Status:** Draft
- **Last Updated:** 2026-05-13

---

## Revision History

| Version | Date | Comment | Author | Approver |
|---------|------|---------|--------|----------|
| 0.0b | 2026-05-13 | Updated documentation metadata and standards compliance | LGSI-KarumuriHari | - |
| 0.0a | 2026-02-24 | Initial LLD document creation | Eclipse timpani Team | - |

---

Comment thread
LGSI-KarumuriHari marked this conversation as resolved.
**Component Type:** Kernel Monitoring
**Responsibility:** Deadline miss detection, scheduler statistics via eBPF
**Status:** ⏸️ Not Started in Rust
Expand Down
17 changes: 17 additions & 0 deletions doc/architecture/LLD/timpani-n/08-communication-libtrpc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,23 @@

# LLD: Communication (libtrpc → gRPC)

**Document Information:**
- **Issuing Author:** Eclipse timpani Team
- **Configuration ID:** timpani-n-lld-08
- **Document Status:** Draft
- **Last Updated:** 2026-05-13

---

## Revision History

| Version | Date | Comment | Author | Approver |
|---------|------|---------|--------|----------|
| 0.0b | 2026-05-13 | Updated documentation metadata and standards compliance | LGSI-KarumuriHari | - |
| 0.0a | 2026-02-24 | Initial LLD document creation | Eclipse timpani Team | - |

---

Comment thread
LGSI-KarumuriHari marked this conversation as resolved.
**Component Type:** RPC Communication
**Responsibility:** Communication with timpani-o, schedule retrieval, synchronization, deadline miss reporting
**Status:** ✅ Complete in Rust (gRPC client implemented)
Expand Down
17 changes: 17 additions & 0 deletions doc/architecture/LLD/timpani-n/09-resource-management.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,23 @@

# LLD: Resource Management

**Document Information:**
- **Issuing Author:** Eclipse timpani Team
- **Configuration ID:** timpani-n-lld-09
- **Document Status:** Draft
- **Last Updated:** 2026-05-13

---

## Revision History

| Version | Date | Comment | Author | Approver |
|---------|------|---------|--------|----------|
| 0.0b | 2026-05-13 | Updated documentation metadata and standards compliance | LGSI-KarumuriHari | - |
| 0.0a | 2026-02-24 | Initial LLD document creation | Eclipse timpani Team | - |

---

Comment thread
LGSI-KarumuriHari marked this conversation as resolved.
**Component Type:** Cleanup & State Management
**Responsibility:** Resource cleanup, global state, graceful shutdown
**Status:** ⏸️ Not Started in Rust
Expand Down
17 changes: 17 additions & 0 deletions doc/architecture/LLD/timpani-n/10-data-structures.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,23 @@

# LLD: Data Structures

**Document Information:**
- **Issuing Author:** Eclipse timpani Team
- **Configuration ID:** timpani-n-lld-10
- **Document Status:** Draft
- **Last Updated:** 2026-05-13

---

## Revision History

| Version | Date | Comment | Author | Approver |
|---------|------|---------|--------|----------|
| 0.0b | 2026-05-13 | Updated documentation metadata and standards compliance | LGSI-KarumuriHari | - |
| 0.0a | 2026-02-24 | Initial LLD document creation | Eclipse timpani Team | - |

---

Comment thread
LGSI-KarumuriHari marked this conversation as resolved.
**Component Type:** Core Data Models
**Responsibility:** Context, task info, runtime state structures
**Status:** 🔄 Partial (structures defined in Rust, not used yet)
Expand Down
45 changes: 17 additions & 28 deletions doc/architecture/LLD/timpani-n/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,23 @@

# timpani-n Low-Level Design (LLD) Documentation

**Document Information:**
- **Issuing Author:** Eclipse timpani Team
- **Configuration ID:** timpani-n-lld-index
- **Document Status:** Draft
- **Last Updated:** 2026-05-13

---

## Revision History

| Version | Date | Comment | Author | Approver |
|---------|------|---------|--------|----------|
| 0.0b | 2026-05-13 | Updated documentation metadata and standards compliance | LGSI-KarumuriHari | - |
| 0.0a | 2026-02-24 | Initial LLD documentation set | Eclipse timpani Team | - |

---

Comment thread
LGSI-KarumuriHari marked this conversation as resolved.
**Project:** Eclipse Timpani - Real-Time Task Orchestration Framework
**Component:** timpani-n (Node Executor)
**Migration:** C → Rust (In Progress - Initialization Phase Only)
Expand Down Expand Up @@ -250,34 +267,6 @@ Check these to see what's been ported:

---

## Migration Roadmap

### Step 1: Foundation (Current - M2)
- ✅ CLI and configuration parsing
- 🔄 Basic initialization structure
- ⏸️ Context management

### Step 2: Core Runtime (Planned)
- ⏸️ Time trigger execution loop
- ⏸️ Hyperperiod calculation
- ⏸️ Timer management

### Step 3: Communication (Planned)
- ⏸️ gRPC client to timpani-o
- ⏸️ Task schedule retrieval
- ⏸️ Synchronization protocol

### Step 4: Execution (Planned)
- ⏸️ Real-time scheduling (CPU affinity, RT priority)
- ⏸️ Signal handling
- ⏸️ Task activation

### Step 5: Monitoring (Planned)
- ⏸️ eBPF integration (aya or libbpf-rs)
- ⏸️ Deadline miss detection
- ⏸️ Performance statistics

---

## Important Notes

Expand Down
17 changes: 17 additions & 0 deletions doc/architecture/LLD/timpani-o/01-schedinfo-service.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,23 @@

# LLD: SchedInfoService Component

**Document Information:**
- **Issuing Author:** Eclipse timpani Team
- **Configuration ID:** timpani-o-lld-01
- **Document Status:** Draft
- **Last Updated:** 2026-05-13

---

## Revision History

| Version | Date | Comment | Author | Approver |
|---------|------|---------|--------|----------|
| 0.0b | 2026-05-13 | Updated documentation metadata and standards compliance | LGSI-KarumuriHari | - |
| 0.0a | 2026-02-24 | Initial LLD document creation | Eclipse timpani Team | - |

---

Comment thread
LGSI-KarumuriHari marked this conversation as resolved.
**Component Type:** gRPC Service
**Responsibility:** Receive and process workload schedules from Pullpiri orchestrator
**Status:** ✅ Migrated (C++ → Rust)
Expand Down
17 changes: 17 additions & 0 deletions doc/architecture/LLD/timpani-o/02-fault-service-client.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,23 @@

# LLD: FaultService Client Component

**Document Information:**
- **Issuing Author:** Eclipse timpani Team
- **Configuration ID:** timpani-o-lld-02
- **Document Status:** Draft
- **Last Updated:** 2026-05-13

---

## Revision History

| Version | Date | Comment | Author | Approver |
|---------|------|---------|--------|----------|
| 0.0b | 2026-05-13 | Updated documentation metadata and standards compliance | LGSI-KarumuriHari | - |
| 0.0a | 2026-02-24 | Initial LLD document creation | Eclipse timpani Team | - |

---

Comment thread
LGSI-KarumuriHari marked this conversation as resolved.
**Component Type:** gRPC Client
**Responsibility:** Report fault events (deadline misses) to Pullpiri orchestrator
**Status:** ✅ Migrated (C++ → Rust)
Expand Down
17 changes: 17 additions & 0 deletions doc/architecture/LLD/timpani-o/03-dbus-server-node-service.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,23 @@

# LLD: D-Bus Server / Node Service Component

**Document Information:**
- **Issuing Author:** Eclipse timpani Team
- **Configuration ID:** timpani-o-lld-03
- **Document Status:** Draft
- **Last Updated:** 2026-05-13

---

## Revision History

| Version | Date | Comment | Author | Approver |
|---------|------|---------|--------|----------|
| 0.0b | 2026-05-13 | Updated documentation metadata and standards compliance | LGSI-KarumuriHari | - |
| 0.0a | 2026-02-24 | Initial LLD document creation | Eclipse timpani Team | - |

---

Comment thread
LGSI-KarumuriHari marked this conversation as resolved.
**Component Type:** Communication Server
**Responsibility:** Serve scheduling information and coordinate synchronization with timpani-n nodes
**Status:** ✅ Migrated (C++ D-Bus → Rust gRPC)
Expand Down
Loading
Loading