Skip to content

Commit a1cbc51

Browse files
committed
Polish release positioning and notes
1 parent 261d577 commit a1cbc51

2 files changed

Lines changed: 24 additions & 8 deletions

File tree

CHANGELOG.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,19 @@ All notable changes to this project will be documented in this file.
44

55
## v0.1.0
66

7-
- initial CPUOpt-Kernel scaffold
8-
- safe Intel-first userspace controller
9-
- fixture-backed discovery and profile tests
10-
- dry-run side effects removed for snapshot and write log paths
11-
- apply-time write revalidation added
12-
- GitHub Actions CI, license, contribution, and security docs added
7+
- initial public release of CPUOpt-Kernel
8+
- Intel-first, sysfs-first userspace controller with `status`, `discover`, `profile`,
9+
`monitor`, `restore`, and `export-json` commands
10+
- safe profile mappings for `performance`, `balanced`, `latency`, `quiet`, and
11+
`ai-inference`
12+
- discovery coverage for CPUFreq, `intel_pstate`, `amd-pstate`, cpuidle, topology, NUMA,
13+
thermal zones, cooling devices, and hwmon metadata
14+
- reversible write model with snapshot/restore support for non-dry-run profile application
15+
- dry-run behavior hardened so `--dry-run` performs zero filesystem modifications,
16+
including no snapshot and no write log generation
17+
- apply-time write revalidation added through `ProposedWrite.valid_values`
18+
- fake sysfs fixtures and unit tests for discovery, profile decisions, dry-run safety, and
19+
invalid-value rejection
20+
- placeholder kernel module scaffolding for future `/sys/kernel/cpuopt/` integration
21+
- GitHub Actions CI, GPL-2.0-only licensing, contribution guidance, security policy, and
22+
release metadata added

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,14 @@
55
[![python](https://img.shields.io/badge/python-3.10%2B-blue.svg)](https://www.python.org/)
66
[![version](https://img.shields.io/badge/version-v0.1.0-informational.svg)](https://github.com/manishklach/cpuopt-kernel/blob/main/CHANGELOG.md)
77

8-
CPUOpt-Kernel translates vendor CPU performance controls into safe Linux policy profiles.
9-
It prefers existing kernel interfaces over raw register writes and treats thermal and fan
8+
CPUOpt-Kernel is not an overclocking tool. It is a safety-first CPU performance policy layer
9+
that discovers platform capabilities and maps them into reversible workload profiles such as
10+
`performance`, `balanced`, `latency`, `quiet`, and `ai-inference`. The project starts with a
11+
sysfs-first Intel MVP and is designed for future AMD `amd-pstate` and ARM
12+
SCMI/heterogeneous-topology backends.
13+
14+
CPUOpt-Kernel translates vendor CPU performance controls into safe Linux policy profiles. It
15+
prefers existing kernel interfaces over raw register writes and treats thermal and fan
1016
control as platform concerns, not as a shortcut for unsafe CPU tuning.
1117

1218
Version `v0.1` is intentionally conservative:

0 commit comments

Comments
 (0)