kernel-glossary

Category: Docs & Knowledge | Uploader: 0xff07 | Downloads: 0 | Version: v1.0（Latest）

Generate structured Linux kernel documentation pages for this knowledge base.

Changelog: Source: GitHub https://github.com/0xff07/kernel-glossary

Directory Structure

Current level: Root

📁 docs/
- 📁 concurrency/
  - 📄 compiler-barriers.md 321 B
  - 📄 cpu-barriers.md 584 B
  - 📄 dl_sched.md 719 B
  - 📄 fair_sched.md 765 B
  - 📄 hrtimer.md 514 B
  - 📄 irq.md 437 B
  - 📄 memory-model.md 528 B
  - 📄 mutex.md 331 B
  - 📄 preemption.md 669 B
  - 📄 processes.md 621 B
  - 📄 rcu.md 398 B
  - 📄 rt_sched.md 394 B
  - 📄 scheduler-overview.md 759 B
  - 📄 semaphore.md 190 B
  - 📄 softirq.md 538 B
  - 📄 spinlock.md 507 B
  - 📄 strace.md 671 B
  - 📄 system-calls.md 690 B
  - 📄 tasklet.md 371 B
  - 📄 threaded-irq.md 339 B
  - 📄 time.md 365 B
  - 📄 vdso.md 182 B
  - 📄 workqueue.md 474 B
- 📁 debugging/
  - 📄 bpftrace.md 368 B
  - 📄 call-trace-analysis.md 616 B
  - 📄 coccinelle.md 361 B
  - 📄 debugfs.md 317 B
  - 📄 debugging-overview.md 536 B
  - 📄 decode_stacktrace.md 462 B
  - 📄 drgn.md 277 B
  - 📄 dynamic-debug.md 439 B
  - 📄 event-sources.md 330 B
  - 📄 kasan.md 579 B
  - 📄 kcsan.md 593 B
  - 📄 kdump.md 567 B
  - 📄 kfence.md 469 B
  - 📄 kgdb.md 472 B
  - 📄 kmemleak.md 214 B
  - 📄 kprobe.md 333 B
  - 📄 lockdep.md 298 B
  - 📄 pstore.md 299 B
  - 📄 sanitizer-overview.md 578 B
  - 📄 smatch.md 364 B
  - 📄 sparse.md 241 B
  - 📄 trace-cmd.md 387 B
  - 📄 tracefs.md 525 B
  - 📄 tracepoints.md 581 B
  - 📄 tracing-overview.md 387 B
  - 📄 ubsan.md 210 B
- 📁 drivers/
  - 📄 acpi.md 743 B
  - 📄 clocks.md 428 B
  - 📄 device-tree.md 661 B
  - 📄 device_link.md 196 B
  - 📄 dma.md 429 B
  - 📄 driver-model.md 765 B
  - 📄 dt-schema.md 222 B
  - 📄 firmware.md 525 B
  - 📄 gpio.md 958 B
  - 📄 i2c.md 489 B
  - 📄 interrupts.md 630 B
  - 📄 kernel-modules.md 506 B
  - 📄 pci.md 1.2 KB
  - 📄 pinctrl.md 396 B
  - 📄 platform-bus.md 230 B
  - 📄 regmap.md 204 B
  - 📄 spi.md 494 B
  - 📄 udev.md 981 B
  - 📄 usb.md 461 B
- 📁 drm/
  - 📄 apitrace.md 503 B
  - 📄 display-pipeline.md 779 B
  - 📄 dp-mst.md 302 B
  - 📄 dp.md 628 B
  - 📄 drm-ci.md 536 B
  - 📄 drm-kunit.md 378 B
  - 📄 drm.md 1.0 KB
  - 📄 edid.md 216 B
  - 📄 hdmi.md 403 B
  - 📄 igt-gpu-tools.md 433 B
  - 📄 kms-atomic.md 1.0 KB
  - 📄 kms-bridges.md 689 B
  - 📄 kms.md 1.6 KB
  - 📄 libdrm.md 231 B
  - 📄 libinput.md 231 B
  - 📄 lvds.md 541 B
  - 📄 mesa.md 379 B
  - 📄 mutter.md 217 B
  - 📄 rendering-pipeline.md 380 B
  - 📄 rgb.md 368 B
  - 📄 simpledrm.md 401 B
  - 📄 vga.md 489 B
  - 📄 vkms.md 482 B
  - 📄 wayland-protocol.md 345 B
- 📁 pci/
  - 📄 aer.md 7.4 KB
  - 📄 d-states.md 2.6 KB
  - 📄 d3cold.md 779 B
  - 📄 l0.md 190 B
  - 📄 l0s.md 1.1 KB
  - 📄 l1-aspm.md 3.4 KB
  - 📄 l1-pcipm.md 2.5 KB
  - 📄 l1-substates.md 971 B
  - 📄 l2-l3-ready.md 1.4 KB
  - 📄 l2.md 839 B
  - 📄 l3.md 809 B
  - 📄 link-equalization.md 1.1 KB
  - 📄 link-speed-change.md 4.6 KB
  - 📄 link-width-change.md 1.5 KB
  - 📄 ltr.md 1.0 KB
  - 📄 ltssm-configuration.md 2.5 KB
  - 📄 ltssm-detect.md 487 B
  - 📄 ltssm-overview.md 652 B
  - 📄 ltssm-polling.md 1.5 KB
  - 📄 ltssm-recovery.md 1.2 KB
  - 📄 pme.md 2.9 KB
  - 📄 ts1-ts2.md 961 B
- 📁 pm/
  - 📄 acpi-c-states.md 689 B
  - 📄 acpi-debugging.md 4.5 KB
  - 📄 acpi-p-states.md 412 B
  - 📄 acpi-pm-objects.md 477 B
  - 📄 acpi-s-states.md 425 B
  - 📄 cpufreq.md 599 B
  - 📄 cpuidle.md 228 B
  - 📄 opp.md 347 B
  - 📄 pm-domain.md 629 B
  - 📄 pm-overview.md 708 B
  - 📄 qos.md 223 B
  - 📄 runtime-pm.md 613 B
  - 📄 s0ix.md 1.5 KB
  - 📄 s2idle-freeze.md 247 B
  - 📄 s2ram-deep.md 387 B
  - 📄 standby.md 314 B
  - 📄 system-wide-suspend.md 1014 B
  - 📄 thermal.md 342 B
  - 📄 thermald.md 170 B
- 📁 sound/
  - 📄 alsa-lib.md 429 B
  - 📄 alsa-ucm-conf.md 229 B
  - 📄 alsa.md 594 B
  - 📄 asoc.md 1.2 KB
  - 📄 dapm.md 421 B
  - 📄 hda.md 456 B
  - 📄 pipewire.md 417 B
  - 📄 pulseaudio.md 179 B
  - 📄 sof.md 1.6 KB
  - 📄 soundwire.md 453 B
  - 📄 wireplumber.md 425 B
- 📁 templates/
  - 📄 TEMPLATE-FULL.md 412 B
- 📁 workflows/
  - 📄 ai-assisted-coding.md 248 B
  - 📄 applying-patches.md 973 B
  - 📄 autosel.md 235 B
  - 📄 b4.md 1.2 KB
  - 📄 backporting.md 1.3 KB
  - 📄 compiling-kernel-cross.md 343 B
  - 📄 compiling-kernel-native.md 659 B
  - 📄 development-process.md 900 B
  - 📄 git-basics.md 488 B
  - 📄 git-bisect.md 510 B
  - 📄 git-cherry-pick.md 280 B
  - 📄 git-interrogators.md 452 B
  - 📄 git-rebase-interactive.md 529 B
  - 📄 git-rebase.md 319 B
  - 📄 git-send-email.md 459 B
  - 📄 git-worktree.md 347 B
  - 📄 kbuild.md 255 B
  - 📄 kconfig.md 430 B
  - 📄 kernel-binaries.md 577 B
  - 📄 kernel-coding-patterns.md 421 B
  - 📄 kernel-release-model.md 562 B
  - 📄 lei.md 727 B
  - 📄 patch-format.md 365 B
  - 📄 patchwise.md 148 B
  - 📄 patman.md 218 B
  - 📄 stable-releases.md 387 B
  - 📄 upstreaming-process.md 671 B
  - 📄 xapian-query-syntax.md 456 B
- 📄 README.md 3.0 KB
- 📄 TAGS.md 31 B
📄 mkdocs.yml 8.2 KB
📄 SKILL.md 7.5 KB

SKILL.md

---
name: kernel-glossary
description: >
  Generate structured Linux kernel documentation pages for this knowledge base.
user-invocable: true
---

# kernel-glossary

Generate a Linux kernel documentation page following this project's conventions.

## Input

`$ARGUMENTS` or conversation context provides:
- The subsystem (e.g., xHCI, PCIe, ACPI, USB4, DRM)
- The topic name (e.g., "host controller initialization", "MSI-X vectors")
- Optionally, an output directory override

If `$ARGUMENTS` is empty, derive the subsystem and topic from the conversation context.

## Procedure

### 1. Read the template

Before generating any content, read this file relative to `${CLAUDE_SKILL_DIR}`:

- `docs/templates/TEMPLATE-FULL.md` (page structure and section order)

### 2. Determine subsystem and output path

Look up the subsystem in the Subsystem Map (at the end of this file) to find:

- `tag`: the value for the `topics` and `tags` front matter fields
- `dir`: the output directory under `docs/`
- `kernel_paths`: directories in the kernel source tree to search first
- `spec`: specification name(s) for the SPECIFICATIONS section
- `section6_heading`: the heading to use for section 6 (REGISTERS, METHODS, PRIMITIVES, INTERFACES, or omit)

Construct the output path: `${CLAUDE_SKILL_DIR}/docs/<dir>/<topic-slug>.md`

If the output directory does not exist, create it.

### 3. Check for an existing page

Check whether a file already exists at the computed output path (`${CLAUDE_SKILL_DIR}/docs/<dir>/<topic-slug>.md`).

If the file exists, proceed to step 4.

If no file exists, stop and ask the user what to do. State the topic and subsystem you identified, then present these options:

1. Search the local kernel source tree and generate a full page (steps 4-9).
2. Create a minimal stub page now, without searching the kernel tree.
3. Cancel.

Wait for the user to choose before proceeding.

### 4. Search local kernel source code

Search the local kernel source tree (not the web) for relevant code. Use Grep and Glob to find:

- Source files in `kernel_paths` relevant to the topic
- Function definitions (with line numbers) using patterns like `^(static\s+)?\w+.*\bfunction_name\b\s*\(`
- Struct and macro definitions
- Comments referencing specification sections
- Files under `Documentation/` related to the topic

Record exact file paths and line numbers for every function, struct, or macro found.

### 5. Construct GitHub URLs

Use the base URL: `https://github.com/torvalds/linux/blob/v6.19/`

For file references:
```
[`path/to/file.c`](https://github.com/torvalds/linux/blob/v6.19/path/to/file.c)
```

For function references (include line number):
```
[`'\<function_name\>':'path/to/file.c'`](https://github.com/torvalds/linux/blob/v6.19/path/to/file.c#L1234)
```

For kernel documentation files:
```
[`Documentation/subsystem/file.rst`](https://github.com/torvalds/linux/blob/v6.19/Documentation/subsystem/file.rst): brief description
```

### 6. Identify specifications

Check source code comments and headers for references to specification chapters and sections. Map the subsystem to its known specifications using the `spec` field from the Subsystem Map.

Format each entry as: `<spec name>, section <N.N>: <section title>`

If no specification applies, leave the SPECIFICATIONS section present but empty.

### 7. Generate the page

Follow the template structure exactly. The page must contain these sections in order:

1. YAML front matter with `topics` and `tags` (include `"verification-needed"` tag)
2. H1: the topic name (just the name, no extra text)
3. A short summary paragraph with an ASCII diagram if appropriate
4. `## SUMMARY`
5. `## SPECIFICATIONS`
6. `## LINUX KERNEL`
7. `## KERNEL DOCUMENTATION`
8. `## OTHER SOURCES`
9. `## <section6_heading>` (from Subsystem Map; omit entirely if set to "none")
10. `## DETAILS`

### 8. Writing rules (mandatory)

All generated content must follow these rules:

- No em-dashes. Use parentheses instead: "CC (Command Completed)" not "CC --- Command Completed"
- No boldface (`**...**`)
- No negative constructions. Write "It is synchronous" not "It is synchronous, not asynchronous"
- No question-style headings. Write "Enable the Events" not "How Events Are Enabled"
- H1 is always the topic name only
- Every generated or modified page gets the `"verification-needed"` tag (at most one instance)
- Do not add any tags other than `"verification-needed"`
- `Documentation/` references go in KERNEL DOCUMENTATION, never in OTHER SOURCES

### 9. Save the page

Write the completed page to: `${CLAUDE_SKILL_DIR}/docs/<dir>/<topic-slug>.md`

Do not modify `mkdocs.yml`.

Ask before doing actual save.

## Subsystem Map

Each entry maps a subsystem to its tag, output directory, primary kernel source paths, specification name(s), and the heading to use for section 6.

### PCIe

- tag: `pcie`
- dir: `pci`
- kernel_paths: `drivers/pci/`, `include/linux/pci.h`, `include/uapi/linux/pci_regs.h`
- spec: PCI Express Base Specification
- section6_heading: REGISTERS

### xHCI

- tag: `usb` (secondary: `xhci`)
- dir: `xhci`
- kernel_paths: `drivers/usb/host/xhci*`, `include/linux/usb/hcd.h`
- spec: xHCI (eXtensible Host Controller Interface) Specification
- section6_heading: REGISTERS

### USB

- tag: `usb`
- dir: `usb`
- kernel_paths: `drivers/usb/core/`, `drivers/usb/common/`, `include/linux/usb.h`, `include/linux/usb/ch9.h`
- spec: USB 2.0 Specification, USB 3.2 Specification
- section6_heading: REGISTERS

### ACPI

- tag: `acpi`
- dir: `acpi`
- kernel_paths: `drivers/acpi/`, `include/acpi/`, `include/linux/acpi.h`
- spec: ACPI Specification
- section6_heading: METHODS

### USB4

- tag: `usb4`
- dir: `usb4`
- kernel_paths: `drivers/thunderbolt/`, `include/linux/thunderbolt.h`
- spec: USB4 Specification, Thunderbolt 3/4 Specification
- section6_heading: REGISTERS

### DisplayPort

- tag: `display-port`
- dir: `dp`
- kernel_paths: `drivers/gpu/drm/display/drm_dp*`, `include/drm/display/drm_dp*`
- spec: VESA DisplayPort Standard, VESA eDP Standard
- section6_heading: REGISTERS

### DRM

- tag: `graphics`
- dir: `drm`
- kernel_paths: `drivers/gpu/drm/`, `include/drm/`, `include/uapi/drm/`
- spec: (none; refer to DRM subsystem documentation)
- section6_heading: INTERFACES

### Sound

- tag: `sound`
- dir: `sound`
- kernel_paths: `sound/`, `include/sound/`, `include/uapi/sound/`
- spec: Intel High Definition Audio Specification, USB Audio Class Specification
- section6_heading: REGISTERS

### Power Management

- tag: `power-management`
- dir: `pm`
- kernel_paths: `drivers/base/power/`, `kernel/power/`, `include/linux/pm.h`, `include/linux/suspend.h`
- spec: ACPI Specification (power management chapters), PCI PM Specification
- section6_heading: none

### Concurrency

- tag: `concurrency`
- dir: `concurrency`
- kernel_paths: `kernel/locking/`, `include/linux/spinlock.h`, `include/linux/mutex.h`, `include/linux/rwsem.h`
- spec: (none)
- section6_heading: PRIMITIVES

### Drivers

- tag: `drivers`
- dir: `drivers`
- kernel_paths: `drivers/base/`, `include/linux/device.h`, `include/linux/platform_device.h`
- spec: (none)
- section6_heading: INTERFACES

### Debugging

- tag: `debugging`
- dir: `debugging`
- kernel_paths: `kernel/trace/`, `lib/dynamic_debug.c`, `include/linux/ftrace.h`
- spec: (none)
- section6_heading: none

### ARM64

- tag: `arm64`
- dir: `arm64`
- kernel_paths: `arch/arm64/`, `include/asm-generic/`
- spec: Arm Architecture Reference Manual (Arm ARM)
- section6_heading: REGISTERS

### Workflows

- tag: `workflows`
- dir: `workflows`
- kernel_paths: (none; workflow pages describe development processes)
- spec: (none)
- section6_heading: none

Comments 0

Latest | Hot

Please login before commenting.

No comments yet. Be the first one!

kernel-glossary

Directory Structure

SKILL.md

Report

Notice