Re: [RFC] doc: add maintainer book

Greg Kroah-Hartman
2017-11-22T09:52:05Z

On Wed, Nov 22, 2017 at 09:39:39AM +1100, Tobin C. Harding wrote:
> 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>
> ---
>
> Linus and Greg are CC'd because they are quoted heavily in the document.
>
> Greg,
>
> This is my second attempt at this but still it reads as if I am saying things
> that actually you said. I feel this is in the spirit of your original message
> but I would still like you to okay it please. Any suggestions (from anyone) on a
> better way to word, or structure, the document most welcome.

This looks great to me, thanks for starting it out. It can be added to
more later (like the 'how to set up git' section), but that is easier to
add to an existing document rather than just starting with none.

Reviewed-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>