path: root/Documentation/maintainer/configure-git.rst
diff options
authorTobin C. Harding <>2017-12-04 10:27:29 +1100
committerJonathan Corbet <>2017-12-11 14:43:24 -0700
commit9727a0144bd99f4a189a2ededd52c53299079d8a (patch)
treec8fedac9b3888e0f145eb8dc6b1c968c29f33725 /Documentation/maintainer/configure-git.rst
parentb6e859f6cdd1686c021dcb3e18591d0b28ce8867 (diff)
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 <> Reviewed-by: Greg Kroah-Hartman <> Reviewed-by: Mauro Carvalho Chehab <> Signed-off-by: Jonathan Corbet <>
Diffstat (limited to 'Documentation/maintainer/configure-git.rst')
1 files changed, 34 insertions, 0 deletions
diff --git a/Documentation/maintainer/configure-git.rst b/Documentation/maintainer/configure-git.rst
new file mode 100644
index 000000000000..78bbbb0d2c84
--- /dev/null
+++ b/Documentation/maintainer/configure-git.rst
@@ -0,0 +1,34 @@
+.. _configuregit:
+Configure Git
+This chapter describes maintainer level git configuration.
+Tagged branches used in :ref:`Documentation/maintainer/pull-requests.rst
+<pullrequests>` should be signed with the developers public GPG key. Signed
+tags can be created by passing the ``-u`` flag to ``git tag``. However,
+since you would *usually* use the same key for the same project, you can
+set it once with
+ git config user.signingkey "keyname"
+Alternatively, edit your ``.git/config`` or ``~/.gitconfig`` file by hand:
+ [user]
+ name = Jane Developer
+ email =
+ signingkey =
+You may need to tell ``git`` to use ``gpg2``
+ [gpg]
+ program = /path/to/gpg2
+You may also like to tell ``gpg`` which ``tty`` to use (add to your shell rc file)
+ export GPG_TTY=$(tty)