mirror of
https://github.com/torvalds/linux.git
synced 2026-03-08 03:04:51 +01:00
72c395024d
fair amount going on, including:
- Some signs of life on the long-moribund Japanese translation
- Documentation on policies around the use of generative tools for patch
submissions, and a separate document intended for consumption by
generative tools.
- The completion of the move of the documentation tools to tools/docs. For
now we're leaving a /scripts/kernel-doc symlink behind to avoid breaking
scripts.
- Ongoing build-system work includes the incorporation of documentation in
Python code, better support for documenting variables, and lots of
improvements and fixes.
- Automatic linking of man-page references -- cat(1), for example -- to
the online pages in the HTML build.
...and the usual array of typo fixes and such.
-----BEGIN PGP SIGNATURE-----
iQFDBAABCgAtFiEEIw+MvkEiF49krdp9F0NaE2wMflgFAmmKM8YPHGNvcmJldEBs
d24ubmV0AAoJEBdDWhNsDH5YLK4H/2gqVxY8wKbVymiB95/zudiba8EtWlKE4hZl
KAd4+csZ8RCTMxHJLI23FXOi56CYr3XOQol0DIDUGimQiQx/Cxa2QDWewpkqbNH1
tHPTaNWAj16wKzrZxXhWt+6FoBHd7wrqilLH180IRmezRhu+7kURQ5XEAAXfK08B
CfDXBsCpnGsKn+m72x04cpvnsf/iK3pznbKrZ0ZYGIoaZb6+BV3+jqVaLROWSQZt
Nvt1rYjsi0vaeNapbQL8q72UJ/+zO4nK9am13s7p20zD+jUVY48yfQB/ZqvHp/1L
aymcJUCq0h5sSOHnfSqY5MTZUR/0CK+npRcEPgDYzLBigc9XU9g=
=hHq1
-----END PGP SIGNATURE-----
Merge tag 'docs-7.0' of git://git.kernel.org/pub/scm/linux/kernel/git/docs/linux
Pull documentation updates from Jonathan Corbet:
"A slightly calmer cycle for docs this time around, though there is
still a fair amount going on, including:
- Some signs of life on the long-moribund Japanese translation
- Documentation on policies around the use of generative tools for
patch submissions, and a separate document intended for consumption
by generative tools
- The completion of the move of the documentation tools to
tools/docs. For now we're leaving a /scripts/kernel-doc symlink
behind to avoid breaking scripts
- Ongoing build-system work includes the incorporation of
documentation in Python code, better support for documenting
variables, and lots of improvements and fixes
- Automatic linking of man-page references -- cat(1), for example --
to the online pages in the HTML build
...and the usual array of typo fixes and such"
* tag 'docs-7.0' of git://git.kernel.org/pub/scm/linux/kernel/git/docs/linux: (107 commits)
doc: development-process: add notice on testing
tools: sphinx-build-wrapper: improve its help message
docs: sphinx-build-wrapper: allow -v override -q
docs: kdoc: Fix pdfdocs build for tools
docs: ja_JP: process: translate 'Obtain a current source tree'
docs: fix 're-use' -> 'reuse' in documentation
docs: ioctl-number: fix a typo in ioctl-number.rst
docs: filesystems: ensure proc pid substitutable is complete
docs: automarkup.py: Skip common English words as C identifiers
Documentation: use a source-read extension for the index link boilerplate
docs: parse_features: make documentation more consistent
docs: add parse_features module documentation
docs: jobserver: do some documentation improvements
docs: add jobserver module documentation
docs: kabi: helpers: add documentation for each "enum" value
docs: kabi: helpers: add helper for debug bits 7 and 8
docs: kabi: system_symbols: end docstring phrases with a dot
docs: python: abi_regex: do some improvements at documentation
docs: python: abi_parser: do some improvements at documentation
docs: add kabi modules documentation
...
113 lines
2.5 KiB
ReStructuredText
113 lines
2.5 KiB
ReStructuredText
.. raw:: latex
|
|
|
|
\renewcommand\thesection*
|
|
\renewcommand\thesubsection*
|
|
|
|
.. _process_index:
|
|
|
|
=============================================
|
|
Working with the kernel development community
|
|
=============================================
|
|
|
|
So you want to be a Linux kernel developer? Welcome! While there is a lot
|
|
to be learned about the kernel in a technical sense, it is also important
|
|
to learn about how our community works. Reading these documents will make
|
|
it much easier for you to get your changes merged with a minimum of
|
|
trouble.
|
|
|
|
An introduction to how kernel development works
|
|
-----------------------------------------------
|
|
|
|
Read these documents first: an understanding of the material here will ease
|
|
your entry into the kernel community.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
howto
|
|
development-process
|
|
submitting-patches
|
|
submit-checklist
|
|
|
|
Tools and technical guides for kernel developers
|
|
------------------------------------------------
|
|
|
|
This is a collection of material that kernel developers should be familiar
|
|
with.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
changes
|
|
programming-language
|
|
coding-style
|
|
maintainer-pgp-guide
|
|
email-clients
|
|
applying-patches
|
|
backporting
|
|
adding-syscalls
|
|
volatile-considered-harmful
|
|
botching-up-ioctls
|
|
|
|
Policy guides and developer statements
|
|
--------------------------------------
|
|
|
|
These are the rules that we try to live by in the kernel community (and
|
|
beyond).
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
license-rules
|
|
code-of-conduct
|
|
code-of-conduct-interpretation
|
|
contribution-maturity-model
|
|
kernel-enforcement-statement
|
|
kernel-driver-statement
|
|
stable-api-nonsense
|
|
stable-kernel-rules
|
|
management-style
|
|
researcher-guidelines
|
|
generated-content
|
|
coding-assistants
|
|
conclave
|
|
|
|
Dealing with bugs
|
|
-----------------
|
|
|
|
Bugs are a fact of life; it is important that we handle them properly. The
|
|
documents below provide general advice about debugging and describe our
|
|
policies around the handling of a couple of special classes of bugs:
|
|
regressions and security problems.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
debugging/index
|
|
handling-regressions
|
|
security-bugs
|
|
cve
|
|
embargoed-hardware-issues
|
|
|
|
Maintainer information
|
|
----------------------
|
|
|
|
How to find the people who will accept your patches.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
maintainer-handbooks
|
|
maintainers
|
|
|
|
Other material
|
|
--------------
|
|
|
|
Here are some other guides to the community that are of interest to most
|
|
developers:
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
kernel-docs
|
|
deprecated
|