korg/linux
0
0
Fork 0
mirror of https://mirrors.bfsu.edu.cn/git/linux.git synced 2024-11-11 04:18:39 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: Slight maintainer's guide decrufting

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

Signed-off-by: Jonathan Corbet <corbet@lwn.net>
This commit is contained in:
Jonathan Corbet 2023-07-14 12:31:26 -06:00
parent 803fda1707
commit 75c33a0131
2 changed files with 15 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
Documentation/maintainer/configure-git.rst
View File

@ -1,36 +1,31 @@
.. _configuregit: Configuring Git
===============
Configure Git
=============
This chapter describes maintainer level git configuration. This chapter describes maintainer level git configuration.
Tagged branches used in :ref:`Documentation/maintainer/pull-requests.rst Tagged branches used in pull requests (see
<pullrequests>` should be signed with the developers public GPG key. Signed Documentation/maintainer/pull-requests.rst) should be signed with the
tags can be created by passing ``-u <key-id>`` to ``git tag``. However, developers public GPG key. Signed tags can be created by passing
since you would *usually* use the same key for the project, you can ``-u <key-id>`` to ``git tag``. However, since you would *usually* use the same
set it in the configuration and use the ``-s`` flag. To set the default key for the project, you can set it in the configuration and use the ``-s``
``key-id`` use flag. To set the default ``key-id`` use::
::
git config user.signingkey "keyname" 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] [user]
name = Jane Developer name = Jane Developer
email = jd@domain.org email = jd@domain.org
signingkey = 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] [gpg]
program = /path/to/gpg2 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) 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 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 reference back to the lore archive so that people that browse the commit
history can find related discussions and rationale behind a certain change. 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> Link: https://lore.kernel.org/r/<message-id>
This can be configured to happen automatically any time you issue ``git am`` This can be configured to happen automatically any time you issue ``git am``
by adding the following hook into your git: by adding the following hook into your git::
.. code-block:: none
$ git config am.messageid true $ git config am.messageid true
$ cat >.git/hooks/applypatch-msg <<'EOF' $ cat >.git/hooks/applypatch-msg <<'EOF'

4
Documentation/maintainer/pull-requests.rst
View File

@ -1,5 +1,3 @@
.. _pullrequests:
Creating Pull Requests 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 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 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 Linus will only accept pull requests based on a signed tag. Other
maintainers may differ. maintainers may differ.