doc: add maintainer book
authorTobin C. Harding <me@tobin.cc>
Sun, 3 Dec 2017 23:27:29 +0000 (10:27 +1100)
committerJonathan Corbet <corbet@lwn.net>
Mon, 11 Dec 2017 21:43:24 +0000 (14:43 -0700)
commit9727a0144bd99f4a189a2ededd52c53299079d8a
treec8fedac9b3888e0f145eb8dc6b1c968c29f33725
parentb6e859f6cdd1686c021dcb3e18591d0b28ce8867
doc: add maintainer book

There is currently very little documentation in the kernel on maintainer
level tasks. In particular there are no documents on creating pull
requests to submit to Linus.

Quoting Greg Kroah-Hartman on LKML:

    Anyway, this actually came up at the kernel summit / maintainer
    meeting a few weeks ago, in that "how do I make a
    good pull request to Linus" is something we need to document.

    Here's what I do, and it seems to work well, so maybe we should turn
    it into the start of the documentation for how to do it.

(quote references: kernel summit, Europe 2017)

Create a new kernel documentation book 'how to be a maintainer'
(suggested by Jonathan Corbet). Add chapters on 'configuring git' and
'creating a pull request'.

Most of the content was written by Linus Torvalds and Greg Kroah-Hartman
in discussion on LKML. This is stated at the start of one of the
chapters and the original email thread is referenced in
'pull-requests.rst'.

Signed-off-by: Tobin C. Harding <me@tobin.cc>
Reviewed-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Reviewed-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Documentation/index.rst
Documentation/maintainer/conf.py [new file with mode: 0644]
Documentation/maintainer/configure-git.rst [new file with mode: 0644]
Documentation/maintainer/index.rst [new file with mode: 0644]
Documentation/maintainer/pull-requests.rst [new file with mode: 0644]