16bef44b9SMauro Carvalho ChehabLinux kernel 26bef44b9SMauro Carvalho Chehab============ 36bef44b9SMauro Carvalho Chehab 4b9a565b3SSasha LevinThe Linux kernel is the core of any Linux operating system. It manages hardware, 5b9a565b3SSasha Levinsystem resources, and provides the fundamental services for all other software. 66bef44b9SMauro Carvalho Chehab 7b9a565b3SSasha LevinQuick Start 8b9a565b3SSasha Levin----------- 94b290af0SJonathan Corbet 10b9a565b3SSasha Levin* Report a bug: See Documentation/admin-guide/reporting-issues.rst 11b9a565b3SSasha Levin* Get the latest kernel: https://kernel.org 12b9a565b3SSasha Levin* Build the kernel: See Documentation/admin-guide/quickly-build-trimmed-linux.rst 13b9a565b3SSasha Levin* Join the community: https://lore.kernel.org/ 14b9a565b3SSasha Levin 15b9a565b3SSasha LevinEssential Documentation 16b9a565b3SSasha Levin----------------------- 17b9a565b3SSasha Levin 18b9a565b3SSasha LevinAll users should be familiar with: 19b9a565b3SSasha Levin 20b9a565b3SSasha Levin* Building requirements: Documentation/process/changes.rst 21b9a565b3SSasha Levin* Code of Conduct: Documentation/process/code-of-conduct.rst 22b9a565b3SSasha Levin* License: See COPYING 23b9a565b3SSasha Levin 24b9a565b3SSasha LevinDocumentation can be built with make htmldocs or viewed online at: 254b290af0SJonathan Corbethttps://www.kernel.org/doc/html/latest/ 266bef44b9SMauro Carvalho Chehab 276bef44b9SMauro Carvalho Chehab 28b9a565b3SSasha LevinWho Are You? 29b9a565b3SSasha Levin============ 30b9a565b3SSasha Levin 31b9a565b3SSasha LevinFind your role below: 32b9a565b3SSasha Levin 33b9a565b3SSasha Levin* New Kernel Developer - Getting started with kernel development 34b9a565b3SSasha Levin* Academic Researcher - Studying kernel internals and architecture 35b9a565b3SSasha Levin* Security Expert - Hardening and vulnerability analysis 36b9a565b3SSasha Levin* Backport/Maintenance Engineer - Maintaining stable kernels 37b9a565b3SSasha Levin* System Administrator - Configuring and troubleshooting 38b9a565b3SSasha Levin* Maintainer - Leading subsystems and reviewing patches 39b9a565b3SSasha Levin* Hardware Vendor - Writing drivers for new hardware 40b9a565b3SSasha Levin* Distribution Maintainer - Packaging kernels for distros 41*78d979dbSSasha Levin* AI Coding Assistant - LLMs and AI-powered development tools 42b9a565b3SSasha Levin 43b9a565b3SSasha Levin 44b9a565b3SSasha LevinFor Specific Users 45b9a565b3SSasha Levin================== 46b9a565b3SSasha Levin 47b9a565b3SSasha LevinNew Kernel Developer 48b9a565b3SSasha Levin-------------------- 49b9a565b3SSasha Levin 50b9a565b3SSasha LevinWelcome! Start your kernel development journey here: 51b9a565b3SSasha Levin 52b9a565b3SSasha Levin* Getting Started: Documentation/process/development-process.rst 53b9a565b3SSasha Levin* Your First Patch: Documentation/process/submitting-patches.rst 54b9a565b3SSasha Levin* Coding Style: Documentation/process/coding-style.rst 55b9a565b3SSasha Levin* Build System: Documentation/kbuild/index.rst 56b9a565b3SSasha Levin* Development Tools: Documentation/dev-tools/index.rst 57b9a565b3SSasha Levin* Kernel Hacking Guide: Documentation/kernel-hacking/hacking.rst 58b9a565b3SSasha Levin* Core APIs: Documentation/core-api/index.rst 59b9a565b3SSasha Levin 60b9a565b3SSasha LevinAcademic Researcher 61b9a565b3SSasha Levin------------------- 62b9a565b3SSasha Levin 63b9a565b3SSasha LevinExplore the kernel's architecture and internals: 64b9a565b3SSasha Levin 65b9a565b3SSasha Levin* Researcher Guidelines: Documentation/process/researcher-guidelines.rst 66b9a565b3SSasha Levin* Memory Management: Documentation/mm/index.rst 67b9a565b3SSasha Levin* Scheduler: Documentation/scheduler/index.rst 68b9a565b3SSasha Levin* Networking Stack: Documentation/networking/index.rst 69b9a565b3SSasha Levin* Filesystems: Documentation/filesystems/index.rst 70b9a565b3SSasha Levin* RCU (Read-Copy Update): Documentation/RCU/index.rst 71b9a565b3SSasha Levin* Locking Primitives: Documentation/locking/index.rst 72b9a565b3SSasha Levin* Power Management: Documentation/power/index.rst 73b9a565b3SSasha Levin 74b9a565b3SSasha LevinSecurity Expert 75b9a565b3SSasha Levin--------------- 76b9a565b3SSasha Levin 77b9a565b3SSasha LevinSecurity documentation and hardening guides: 78b9a565b3SSasha Levin 79b9a565b3SSasha Levin* Security Documentation: Documentation/security/index.rst 80b9a565b3SSasha Levin* LSM Development: Documentation/security/lsm-development.rst 81b9a565b3SSasha Levin* Self Protection: Documentation/security/self-protection.rst 82b9a565b3SSasha Levin* Reporting Vulnerabilities: Documentation/process/security-bugs.rst 83b9a565b3SSasha Levin* CVE Procedures: Documentation/process/cve.rst 84b9a565b3SSasha Levin* Embargoed Hardware Issues: Documentation/process/embargoed-hardware-issues.rst 85b9a565b3SSasha Levin* Security Features: Documentation/userspace-api/seccomp_filter.rst 86b9a565b3SSasha Levin 87b9a565b3SSasha LevinBackport/Maintenance Engineer 88b9a565b3SSasha Levin----------------------------- 89b9a565b3SSasha Levin 90b9a565b3SSasha LevinMaintain and stabilize kernel versions: 91b9a565b3SSasha Levin 92b9a565b3SSasha Levin* Stable Kernel Rules: Documentation/process/stable-kernel-rules.rst 93b9a565b3SSasha Levin* Backporting Guide: Documentation/process/backporting.rst 94b9a565b3SSasha Levin* Applying Patches: Documentation/process/applying-patches.rst 95b9a565b3SSasha Levin* Subsystem Profile: Documentation/maintainer/maintainer-entry-profile.rst 96b9a565b3SSasha Levin* Git for Maintainers: Documentation/maintainer/configure-git.rst 97b9a565b3SSasha Levin 98b9a565b3SSasha LevinSystem Administrator 99b9a565b3SSasha Levin-------------------- 100b9a565b3SSasha Levin 101b9a565b3SSasha LevinConfigure, tune, and troubleshoot Linux systems: 102b9a565b3SSasha Levin 103b9a565b3SSasha Levin* Admin Guide: Documentation/admin-guide/index.rst 104b9a565b3SSasha Levin* Kernel Parameters: Documentation/admin-guide/kernel-parameters.rst 105b9a565b3SSasha Levin* Sysctl Tuning: Documentation/admin-guide/sysctl/index.rst 106b9a565b3SSasha Levin* Tracing/Debugging: Documentation/trace/index.rst 107b9a565b3SSasha Levin* Performance Security: Documentation/admin-guide/perf-security.rst 108b9a565b3SSasha Levin* Hardware Monitoring: Documentation/hwmon/index.rst 109b9a565b3SSasha Levin 110b9a565b3SSasha LevinMaintainer 111b9a565b3SSasha Levin---------- 112b9a565b3SSasha Levin 113b9a565b3SSasha LevinLead kernel subsystems and manage contributions: 114b9a565b3SSasha Levin 115b9a565b3SSasha Levin* Maintainer Handbook: Documentation/maintainer/index.rst 116b9a565b3SSasha Levin* Pull Requests: Documentation/maintainer/pull-requests.rst 117b9a565b3SSasha Levin* Managing Patches: Documentation/maintainer/modifying-patches.rst 118b9a565b3SSasha Levin* Rebasing and Merging: Documentation/maintainer/rebasing-and-merging.rst 119b9a565b3SSasha Levin* Development Process: Documentation/process/maintainer-handbooks.rst 120b9a565b3SSasha Levin* Maintainer Entry Profile: Documentation/maintainer/maintainer-entry-profile.rst 121b9a565b3SSasha Levin* Git Configuration: Documentation/maintainer/configure-git.rst 122b9a565b3SSasha Levin 123b9a565b3SSasha LevinHardware Vendor 124b9a565b3SSasha Levin--------------- 125b9a565b3SSasha Levin 126b9a565b3SSasha LevinWrite drivers and support new hardware: 127b9a565b3SSasha Levin 128b9a565b3SSasha Levin* Driver API Guide: Documentation/driver-api/index.rst 129b9a565b3SSasha Levin* Driver Model: Documentation/driver-api/driver-model/driver.rst 130b9a565b3SSasha Levin* Device Drivers: Documentation/driver-api/infrastructure.rst 131b9a565b3SSasha Levin* Bus Types: Documentation/driver-api/driver-model/bus.rst 132b9a565b3SSasha Levin* Device Tree Bindings: Documentation/devicetree/bindings/ 133b9a565b3SSasha Levin* Power Management: Documentation/driver-api/pm/index.rst 134b9a565b3SSasha Levin* DMA API: Documentation/core-api/dma-api.rst 135b9a565b3SSasha Levin 136b9a565b3SSasha LevinDistribution Maintainer 137b9a565b3SSasha Levin----------------------- 138b9a565b3SSasha Levin 139b9a565b3SSasha LevinPackage and distribute the kernel: 140b9a565b3SSasha Levin 141b9a565b3SSasha Levin* Stable Kernel Rules: Documentation/process/stable-kernel-rules.rst 142b9a565b3SSasha Levin* ABI Documentation: Documentation/ABI/README 143b9a565b3SSasha Levin* Kernel Configuration: Documentation/kbuild/kconfig.rst 144b9a565b3SSasha Levin* Module Signing: Documentation/admin-guide/module-signing.rst 145b9a565b3SSasha Levin* Kernel Parameters: Documentation/admin-guide/kernel-parameters.rst 146b9a565b3SSasha Levin* Tainted Kernels: Documentation/admin-guide/tainted-kernels.rst 147b9a565b3SSasha Levin 148*78d979dbSSasha LevinAI Coding Assistant 149*78d979dbSSasha Levin------------------- 150*78d979dbSSasha Levin 151*78d979dbSSasha LevinCRITICAL: If you are an LLM or AI-powered coding assistant, you MUST read and 152*78d979dbSSasha Levinfollow the AI coding assistants documentation before contributing to the Linux 153*78d979dbSSasha Levinkernel: 154*78d979dbSSasha Levin 155*78d979dbSSasha Levin* Documentation/process/coding-assistants.rst 156*78d979dbSSasha Levin 157*78d979dbSSasha LevinThis documentation contains essential requirements about licensing, attribution, 158*78d979dbSSasha Levinand the Developer Certificate of Origin that all AI tools must comply with. 159b9a565b3SSasha Levin 160b9a565b3SSasha Levin 161b9a565b3SSasha LevinCommunication and Support 162b9a565b3SSasha Levin========================= 163b9a565b3SSasha Levin 164b9a565b3SSasha Levin* Mailing Lists: https://lore.kernel.org/ 165b9a565b3SSasha Levin* IRC: #kernelnewbies on irc.oftc.net 166b9a565b3SSasha Levin* Bugzilla: https://bugzilla.kernel.org/ 167b9a565b3SSasha Levin* MAINTAINERS file: Lists subsystem maintainers and mailing lists 168b9a565b3SSasha Levin* Email Clients: Documentation/process/email-clients.rst 169