mkdocs.yml

site_name: Kernel Glossary
theme:
  name: material
plugins:
  - search
  - tags

nav:
  - README: README.md
  - TAGS: TAGS.md
  - Development Process:
    - The kernel community:
      - Overview: workflows/development-process.md
      - Release model: workflows/kernel-release-model.md
      - Stable releases: workflows/stable-releases.md
      - Coding patterns: workflows/kernel-coding-patterns.md
      - Patch format: workflows/patch-format.md
      - Upstreaming process: workflows/upstreaming-process.md
  - Tooling:
    - Git:
      - git basics: workflows/git-basics.md
      - git interrogators: workflows/git-interrogators.md
      - git bisect: workflows/git-bisect.md
      - git worktree: workflows/git-worktree.md
      - git rebase (interactive): workflows/git-rebase-interactive.md
      - git rebase: workflows/git-rebase.md
    - Finding patches:
      - Xapian Query Syntax: workflows/xapian-query-syntax.md
      - lei: workflows/lei.md
    - Applying patches:
      - git cherry-pick: workflows/git-cherry-pick.md
      - Backporting: workflows/backporting.md
      - Applying .mbox and .patch: workflows/applying-patches.md
    - Sending patches:
      - git send-email: workflows/git-send-email.md
      - b4: workflows/b4.md
      - patman: workflows/patman.md
    - Building the kernel:
      - Kconfig: workflows/kconfig.md
      - Kbuild: workflows/kbuild.md
      - Kernel compilation (native): workflows/compiling-kernel-native.md
      - Kernel compilation (cross): workflows/compiling-kernel-cross.md
      - Kernel binaries: workflows/kernel-binaries.md
    - AI tooling:
      - AUTOSEL: workflows/autosel.md
      - PatchWise: workflows/patchwise.md
      - AI-assisted coding: workflows/ai-assisted-coding.md
  - Debugging:
    - Overview:
      - Debugging overview: debugging/debugging-overview.md
    - Print debugging:
      - Dynamic debug: debugging/dynamic-debug.md
      - debugfs: debugging/debugfs.md
    - Call traces:
      - Analyze call traces: debugging/call-trace-analysis.md
      - decode_stacktrace.sh: debugging/decode_stacktrace.md
      - pstore: debugging/pstore.md
    - Postmoterm:
      - kdump:  debugging/kdump.md
      - drgn: debugging/drgn.md
      - kgdb: debugging/kgdb.md
    - Kernel tracing:
      - Tracing overview: debugging/tracing-overview.md
      - ftrace (trace-cmd): debugging/trace-cmd.md
      - ftrace (tracefs): debugging/tracefs.md
      - bpftrace: debugging/bpftrace.md
      - Event sources: debugging/event-sources.md
      - Tracepoints: debugging/tracepoints.md
      - Kprobes: debugging/kprobe.md
    - Sanitizers:
      - Overview: debugging/sanitizer-overview.md
      - KASAN: debugging/kasan.md
      - KMEMLEAD: debugging/kmemleak.md
      - KFENCE: debugging/kfence.md
      - KCSAN: debugging/kcsan.md
      - UBSAN:  debugging/ubsan.md
      - Lockdep: debugging/lockdep.md
    - Static checks:
      - SPARSE: debugging/sparse.md
      - smatch: debugging/smatch.md
      - coccinelle: debugging/coccinelle.md
  - Concurrency:
    - Sources of concurrency:
      - IRQ: concurrency/irq.md
      - softirq: concurrency/softirq.md
      - preemption: concurrency/preemption.md
    - Work deferring:
      - Workqueue: concurrency/workqueue.md
      - tasklet: concurrency/tasklet.md
      - Threaded IRQ: concurrency/threaded-irq.md
    - Locking:
      - spinlock: concurrency/spinlock.md
      - mutex: concurrency/mutex.md
      - semaphore: concurrency/semaphore.md
      - RCU: concurrency/rcu.md
    - Schedulers:
      - Overview: concurrency/scheduler-overview.md
      - Processes: concurrency/processes.md
      - fair_sched: concurrency/fair_sched.md
      - rt_sched: concurrency/rt_sched.md
      - dl_sched: concurrency/dl_sched.md
    - Memory model:
      - Compiler barriers: concurrency/compiler-barriers.md
      - CPU barriers: concurrency/cpu-barriers.md
      - Memory model: concurrency/memory-model.md
    - System calls:
      - System call: concurrency/system-calls.md
      - vDSO: concurrency/vdso.md
      - strace: concurrency/strace.md
    - Time:
      - Timer and timekeeping: concurrency/time.md
      - hrtimer: concurrency/hrtimer.md
  - Drivers:
    - Overview:
      - Kernel modules: drivers/kernel-modules.md
      - Driver model: drivers/driver-model.md
      - udev: drivers/udev.md
    - Hardware Descriptions:
      - Device tree: drivers/device-tree.md
      - ACPI: drivers/acpi.md
    - Buses (non-numerable):
      - I2C: drivers/i2c.md
      - SPI: drivers/spi.md
      - Platform: drivers/platform-bus.md
    - Buses (enumerable):
      - USB: drivers/usb.md
      - PCIe: drivers/pci.md
    - Hardware Resources:
      - GPIO: drivers/gpio.md
      - Interrupts: drivers/interrupts.md
      - pinctrl: drivers/pinctrl.md
      - Clocks: drivers/clocks.md
      - regmap: drivers/regmap.md
      - DMA: drivers/dma.md
      - firmware: drivers/firmware.md
    - Other topics:
      - DT schema: drivers/dt-schema.md
      - device_link: drivers/device_link.md
  - Power Management:
    - Overview:
      - PM Frameworks: pm/pm-overview.md
    - System-wide suspend:
      - System-wide suspend: pm/system-wide-suspend.md
      - Suspend-to-idle: pm/s2idle-freeze.md
      - Standby: pm/standby.md
      - Suspend-to-ram: pm/s2ram-deep.md
    - Other System-wide suspend topics:
      - Modern Standby (S0ix): pm/s0ix.md
      - ACPI S-States: pm/acpi-s-states.md
    - ACPI-related topics:
      - ACPI power management objects: pm/acpi-pm-objects.md
      - ACPI debugging: pm/acpi-debugging.md
    - Device Runtime Power Management:
      - Runtime PM: pm/runtime-pm.md
      - PM Domain (genpd): pm/pm-domain.md
    - CPU Runtime Power Management:
      - cpufreq: pm/cpufreq.md
      - OPP: pm/opp.md
      - ACPI P-States: pm/acpi-p-states.md
    - PM QoS:
      - PM QoS: pm/qos.md
    - CPU Idle:
      - cpuidle: pm/cpuidle.md
      - ACPI C-States: pm/acpi-c-states.md
    - Thermal Management:
      - Thermal subsystem: pm/thermal.md
      - thermald: pm/thermald.md
  - Graphics:
    - Display Interfaces:
      - VGA: drm/vga.md
      - RGB: drm/rgb.md
      - LVDS: drm/lvds.md
      - HDMI: drm/hdmi.md
      - DisplayPort: drm/dp.md
      - DP-MST: drm/dp-mst.md
      - EDID: drm/edid.md
    - Display Pipeline:
      - Display Pipeline: drm/display-pipeline.md
      - KMS: drm/kms.md
      - Atomic KMS: drm/kms-atomic.md
      - KMS Bridges: drm/kms-bridges.md
    - Rendering Pipeline:
      - Rendering Pipeline: drm/rendering-pipeline.md
      - DRI: drm/drm.md
    - Sample drivers:
      - vkms: drm/vkms.md
      - simpledrm: drm/simpledrm.md
    - Userspace Components:
      - libdrm: drm/libdrm.md
      - Mesa: drm/mesa.md
      - Wayland protocol: drm/wayland-protocol.md
      - Mutter: drm/mutter.md
      - libinput: drm/libinput.md
    - Tools:
      - igt-gpu-toos: drm/igt-gpu-tools.md
      - KUnit tests: drm/drm-kunit.md
      - DRM-CI: drm/drm-ci.md
      - apitrace: drm/apitrace.md
  - Audio:
    - ALSA (userspace):
      - alsa-ucm-conf: sound/alsa-ucm-conf.md
      - alsalib (libasound): sound/alsa-lib.md
    - ALSA (kernel):
      - ALSA: sound/alsa.md
      - ASoC: sound/asoc.md
      - DAPM: sound/dapm.md
    - Audio Interfaces:
      - Soundwire: sound/soundwire.md
    - Userspace Services:
      - Pipewire: sound/pipewire.md
      - Wireplumber: sound/wireplumber.md
      - PulseAudio: sound/pulseaudio.md
    - Platform-specific:
      - Sound Open Firmware (SoF): sound/sof.md
      - HDA: sound/hda.md
  - PCIe:
    - LTSSM basics:
      - LTSSM overview: pci/ltssm-overview.md
      - TS1 and TS2: pci/ts1-ts2.md
    - LTSSM states:
      - Detect: pci/ltssm-detect.md
      - Polling: pci/ltssm-polling.md
      - Configuration: pci/ltssm-configuration.md
      - Recovery: pci/ltssm-recovery.md
      - Recovery.Equalization: pci/link-equalization.md
    - LTSSM scenarios:
      - Link speed change: pci/link-speed-change.md
      - Link width change: pci/link-width-change.md
    - Power Management:
      - D-states: pci/d-states.md
      - L0s (by ASPM): pci/l0s.md
      - L1 (by ASPM): pci/l1-aspm.md
      - L1 (by PCI-PM): pci/l1-pcipm.md
      - L1 substates: pci/l1-substates.md
      - L2/L3 Ready: pci/l2-l3-ready.md
      - L2: pci/l2.md
      - L3: pci/l3.md
      - PME: pci/pme.md
      - D3Cold: pci/d3cold.md
      - LTR: pci/ltr.md
    - Error reporting:
      - AER: pci/aer.md