Merge pull request #170 from matthiasbeyer/metadata-doc

Clearify documentation of metadata in "new" command
neithernut · Feb 13, 2018 · 075f667 · 075f667
2 parents e919984 + 86e1479
commit 075f667
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/src/cli.yaml b/src/cli.yaml
@@ -346,13 +346,16 @@ subcommands:
                 help: >
                         Add metadata. Can be passed multiple times.
                         Metadata is added and removed via key-value pairs.
-                        Available Keys are:
+                        Suggested keys are:
                             status=<value>
                             priority=<value>
                             severity=<value>
                             assignee=<value>
                         where <value> is the desired new value to set.
                         Passing an empty value leaves the metadata empty.
+
+                        The metadata is added to a commit as trailer
+                        (see git-interpret-trailers(1)).
                 multiple: true
                 number_of_values: 1
                 takes_value: true