[PATCH docs] docs: maintainers: mention tag -s for signed tags

[PATCH docs] docs: maintainers: mention tag -s for signed tags

[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.

Signed-off-by: Jakub Kicinski <kuba@kernel.org>
---
 Documentation/maintainer/configure-git.rst | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/Documentation/maintainer/configure-git.rst b/Documentation/maintainer/configure-git.rst
index ec0ddfb9cdd3..a054de0c50dc 100644
--- a/Documentation/maintainer/configure-git.rst
+++ b/Documentation/maintainer/configure-git.rst
@@ -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"
-- 
2.41.0

Re: [PATCH docs] docs: maintainers: mention tag -s for signed tags

[Jonathan Corbet]

Jakub Kicinski <kuba@kernel.org> writes:

> 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>
> ---
>  Documentation/maintainer/configure-git.rst | 7 ++++---
>  1 file changed, 4 insertions(+), 3 deletions(-)
>
> diff --git a/Documentation/maintainer/configure-git.rst b/Documentation/maintainer/configure-git.rst
> index ec0ddfb9cdd3..a054de0c50dc 100644
> --- a/Documentation/maintainer/configure-git.rst
> +++ b/Documentation/maintainer/configure-git.rst
> @@ -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
>  ::

Applied, thanks.

jon