From: Eric Ball <eball@linuxfoundation.org>
Date: Wed, 22 May 2019 21:12:27 +0000 (-0700)
Subject: Note in git-tag docs that tag must be annotated
X-Git-Tag: v0.24.0~8
X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=commitdiff_plain;h=b7f307a2c64d9a47498de878ca0be07c0980bf11;p=releng%2Flftools.git

Note in git-tag docs that tag must be annotated

This caused a significant holdup in testing this function. Though
this is a very small change, I believe it can potentially save
future users a lot of frustration.

Change-Id: I1994391ab5cabdbec4aa7e751a5663f6de726f4d
Signed-off-by: Eric Ball <eball@linuxfoundation.org>
---

diff --git a/lftools/cli/sign.py b/lftools/cli/sign.py
index 5a4a00a8..6de41cc2 100644
--- a/lftools/cli/sign.py
+++ b/lftools/cli/sign.py
@@ -42,7 +42,7 @@ def directory(ctx, directory, mode):
 @click.argument('tag')
 @click.pass_context
 def git_tag(ctx, tag):
-    """Sigul sign a git tag."""
+    """Sigul sign an annotated git tag."""
     status = subprocess.call(['sign', 'git-tag', tag])
     sys.exit(status)