Documentation/process/index.rst

   1 .. raw:: latex
   2
   3         \renewcommand\thesection*
   4         \renewcommand\thesubsection*
   5
   6 .. _process_index:
   7
   8 =============================================
   9 Working with the kernel development community
  10 =============================================
  11
  12 So you want to be a Linux kernel developer?  Welcome!  While there is a lot
  13 to be learned about the kernel in a technical sense, it is also important
  14 to learn about how our community works.  Reading these documents will make
  15 it much easier for you to get your changes merged with a minimum of
  16 trouble.
  17
  18 Below are the essential guides that every developer should read.
  19
  20 .. toctree::
  21    :maxdepth: 1
  22
  23    license-rules
  24    howto
  25    code-of-conduct
  26    code-of-conduct-interpretation
  27    development-process
  28    submitting-patches
  29    handling-regressions
  30    programming-language
  31    coding-style
  32    maintainer-handbooks
  33    maintainer-pgp-guide
  34    email-clients
  35    kernel-enforcement-statement
  36    kernel-driver-statement
  37
  38 For security issues, see:
  39
  40 .. toctree::
  41    :maxdepth: 1
  42
  43    security-bugs
  44    embargoed-hardware-issues
  45
  46 Other guides to the community that are of interest to most developers are:
  47
  48 .. toctree::
  49    :maxdepth: 1
  50
  51    changes
  52    stable-api-nonsense
  53    management-style
  54    stable-kernel-rules
  55    submit-checklist
  56    kernel-docs
  57    deprecated
  58    maintainers
  59    researcher-guidelines
  60    contribution-maturity-model
  61
  62 These are some overall technical guides that have been put here for now for
  63 lack of a better place.
  64
  65 .. toctree::
  66    :maxdepth: 1
  67
  68    applying-patches
  69    adding-syscalls
  70    magic-number
  71    volatile-considered-harmful
  72    botching-up-ioctls
  73    clang-format
  74    ../riscv/patch-acceptance
  75    ../core-api/unaligned-memory-access
  76
  77 .. only::  subproject and html
  78
  79    Indices
  80    =======
  81
  82    * :ref:`genindex`