Commit 75c33a01 authored by Jonathan Corbet's avatar Jonathan Corbet
Browse files

docs: Slight maintainer's guide decrufting 



Get rid of some markup cruft and unneeded labels in a pair of maintainer's
manual documents.  No wording changes.

Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 803fda17

Documentation/maintainer/configure-git.rst

+14 −21
Original line number Diff line number Diff line 
.. _configuregit:



Configure Git

=============

Configuring 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 ``-u <key-id>`` to ``git tag``. However,

since you would *usually* use the same key for the project, you can

set it in the configuration and use the ``-s`` flag. To set the default

``key-id`` use

::

Tagged branches used in pull requests (see

Documentation/maintainer/pull-requests.rst) should be signed with the

developers public GPG key. Signed tags can be created by passing

``-u <key-id>`` to ``git tag``. However, since you would *usually* use the same

key for the project, you can set it in the configuration and use the ``-s``

flag. To set the default ``key-id`` use::



	git config user.signingkey "keyname"



Alternatively, edit your ``.git/config`` or ``~/.gitconfig`` file by hand:

::

Alternatively, edit your ``.git/config`` or ``~/.gitconfig`` file by hand::



	[user]

		name = Jane Developer

		email = jd@domain.org

		signingkey = jd@domain.org



You may need to tell ``git`` to use ``gpg2``

::

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)

::

You may also like to tell ``gpg`` which ``tty`` to use (add to your shell

rc file)::



	export GPG_TTY=$(tty)
@@ -44,14 +39,12 @@ of patches here is a recommended practice, and when a maintainer applies a 
patch to a subsystem tree, it is a good idea to provide a Link: tag with a

reference back to the lore archive so that people that browse the commit

history can find related discussions and rationale behind a certain change.

The link tag will look like this:

The link tag will look like this::



    Link: https://lore.kernel.org/r/<message-id>



This can be configured to happen automatically any time you issue ``git am``

by adding the following hook into your git:



.. code-block:: none

by adding the following hook into your git::



	$ git config am.messageid true

	$ cat >.git/hooks/applypatch-msg <<'EOF'

Documentation/maintainer/pull-requests.rst

+1 −3
Original line number Diff line number Diff line 
.. _pullrequests:



Creating Pull Requests

======================
@@ -41,7 +39,7 @@ named ``char-misc-next``, you would be using the following command:: 


that will create a signed tag called ``char-misc-4.15-rc1`` based on the

last commit in the ``char-misc-next`` branch, and sign it with your gpg key

(see :ref:`Documentation/maintainer/configure-git.rst <configuregit>`).

(see Documentation/maintainer/configure-git.rst).



Linus will only accept pull requests based on a signed tag. Other

maintainers may differ.