docs: maintainers: mention tag -s for signed tags
authorJakub Kicinski <kuba@kernel.org>
Thu, 13 Jul 2023 23:06:06 +0000 (16:06 -0700)
committerJonathan Corbet <corbet@lwn.net>
Fri, 14 Jul 2023 18:18:49 +0000 (12:18 -0600)
The documentation talks about -u and how to configure the default
key. It does not mention that once the default key is set one
should use the -s flag. Which is likely what most people end up
using.

Signed-off-by: Jakub Kicinski <kuba@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <20230713230606.1505458-1-kuba@kernel.org>

Documentation/maintainer/configure-git.rst

index ec0ddfb9cdd3c0f2e8f5beebca669981db360c37..a054de0c50dc4d500c072a9586470e1f084d27bc 100644 (file)
@@ -7,9 +7,10 @@ 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
+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"