diff options
| author | Jonathan Corbet <corbet@lwn.net> | 2016-10-27 17:05:10 -0600 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2016-10-27 17:47:58 -0600 |
| commit | 9d2cccdd6c226181c42a7bb0c5ede1583687b618 (patch) | |
| tree | 993ff17c35fd23a71533e63f6943b9bf59e1d5e4 /Documentation/process/index.rst | |
| parent | 2797cd03f5cca4d9fb2875c9f9c995737ce73469 (diff) | |
| parent | 67972a539e9ff1a3ed794c463c4e544442df693e (diff) | |
| download | linux-9d2cccdd6c226181c42a7bb0c5ede1583687b618.tar.gz | |
Merge branch 'doc-tweaks' into docs-next
The creation of the admin and process guides is a great thing, but, without care, we risk replacing a messy docs directory with a few messy Sphinx books. In an attempt to head that off and show what I'm thinking, here's a set of tweaks that, I think, make the existing Sphinx-formatted docs a bit more accessible.
Diffstat (limited to 'Documentation/process/index.rst')
| -rw-r--r-- | Documentation/process/index.rst | 41 |
1 files changed, 29 insertions, 12 deletions
diff --git a/Documentation/process/index.rst b/Documentation/process/index.rst index cddf580671e7..10aa6920709a 100644 --- a/Documentation/process/index.rst +++ b/Documentation/process/index.rst @@ -4,34 +4,51 @@ \renewcommand\thesubsection* -Linux Kernel Development Documentation -====================================== +Working with the kernel development community +============================================= -Contents: +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. + +Below are the essential guides that every developer should read. .. toctree:: - :maxdepth: 2 + :maxdepth: 1 howto - changes - coding-style + code-of-conflict + development-process submitting-patches + coding-style + email-clients + +Other guides to the community that are of interest to most developers are: + +.. toctree:: + :maxdepth: 1 + + changes submitting-drivers stable-api-nonsense management-style stable-kernel-rules + submit-checklist kernel-docs + +These are some overall technical guides that have been put here for now for +lack of a better place. + +.. toctree:: + :maxdepth: 1 + applying-patches - email-clients - submit-checklist - code-of-conflict adding-syscalls magic-number volatile-considered-harmful - development-process - - .. only:: subproject and html Indices |