Skip to contentSkip to conversation

docs: maintainers: mention tag -s for signed tags

PATCH Applied Jakub Kicinski 2 participants 2 messages Jul 13, 2023 – Jul 14, 2023

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 docs: maintainers: mention tag -s for signed tags

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.

---
 Documentation/maintainer/configure-git.rst | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)
Documentation/maintainer/configure-git.rst +4 -3
index ec0ddfb9cdd3..a054de0c50dc 100644
@@ -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"
Signature · 1 line
2.41.0
maintainer Applied
#1 lore raw
Quoted 16 lines · Jakub Kicinski

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.

---
 Documentation/maintainer/configure-git.rst | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)
Documentation/maintainer/configure-git.rst +0 -0
index ec0ddfb9cdd3..a054de0c50dc 100644
@@ -7,9 +7,10 @@ This chapter describes maintainer level git configuration.
 

Documentation/maintainer/configure-git.rst This chapter describes maintainer level git configuration. · line 14

Quoted 10 lines
Documentation/maintainer/configure-git.rst +4 -3
 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
 ::

Applied, thanks.

jon