From 681494a79e6c0e084354eec0229386a696a314c0 Mon Sep 17 00:00:00 2001 From: Arthur Hanson Rasmusson Date: Wed, 23 Sep 2026 13:48:07 -0400 Subject: docs: merge the legacy flat documents, add the CUDA deep-dive and link checks * Merge and remove the pre-reboot flat documents, preserving their still-useful material in the structured tree: debugging workflows and the EPT-livelock case study (05-operations/02), performance microbenchmarks and A/B methodology (05-operations/01), the version-upgrade runbook (05-operations/02 section 4, with corrected host/guest framing), kernel-code pitfalls (07-developers) and the OpenRM build/load order (03-architecture/06 section 7). The remaining legacy files were verified redundant and removed. * docs/README now records where each migrated topic lives. * Portability: the config YAML files are called out as design targets that no code reads yet, with what adding support actually requires today. * Getting started: the OpenRM step is marked optional (native vGPU-management workflows only; the emulated path uses the distro driver). * tools docs: rmtool/rmtop marked as planned, pointing at the implemented tools/rmq subset. * wiki: new CUDA-Userspace-Driver deep-dive page (public-safe, links the canonical userspace/cuda analysis) and index update. * scripts/check-docs-links.py plus a CI step so relative links cannot rot. * STATE.md references to removed documents repointed. --- docs/tools/rmtool.md | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'docs/tools/rmtool.md') diff --git a/docs/tools/rmtool.md b/docs/tools/rmtool.md index a7ec2c6..93140f1 100644 --- a/docs/tools/rmtool.md +++ b/docs/tools/rmtool.md @@ -1,5 +1,10 @@ # rmtool - RM API Swiss Army Knife +> **Status: planned / not implemented.** There is no `tools/rmtool/` directory +> or build target today. The implemented RM-API tooling is the `rmq` subset +> (`tools/rmq/`, the host RM-API oracle); treat this page as a design sketch, +> not a user guide. See [tools/README.md](README.md). + ## Overview `rmtool` is a comprehensive userspace utility for interacting with the NVIDIA Resource Manager (RM) API. It provides direct access to RM internal state, engine control, memory management, and performance telemetry. Built on top of driver components studied through reverse engineering and decompilation (referenced by component). -- cgit v1.2.3