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