commit: mention -e as nice option

Even though just passing `-e` works (as it is just passed to git), many
users don't know the existence of this option, so now I publish it in
help.

Closes: https://bugs.gentoo.org/846785
Signed-off-by: Arthur Zamarin <arthurzam@gentoo.org>

Author: arthurzam

completion/bash/pkgdev

@@ -75,6 +75,7 @@ _pkgdev() {
                 --signoff
                 -m --message
                 -M --message-template
+                -e --edit
                 -u --update
                 -a --all
             "

completion/zsh/_pkgdev

@@ -50,6 +50,7 @@ case $state in
           '--signoff[add a Signed-off-by trailer]' \
           \*{--message,-m}'[specify commit message]:message' \
           {'(--message-template)-M','(-M)--message-template'}'[use commit message template from specified file]:template:_files' \
+          {'(--edit)-e','(-e)--edit'}'[force edit of commit]' \
           {'(--update)-u','(-u)--update'}'[stage all changed files]' \
           {'(--all)-a','(-a)--all'}'[stage all changed/new/removed files]' \
           && ret=0

doc/man/pkgdev

@@ -0,0 +1 @@
+/home/arthur/src/pkgcore/pkgdev/doc/generated/pkgdev

src/pkgdev/scripts/pkgdev_commit.py

@@ -45,6 +45,8 @@ def parse_known_args(self, args=None, namespace=None):
             args.append('-v')
         if namespace.signoff:
             args.append('--signoff')
+        if namespace.edit:
+            args.append('--edit')
         namespace.commit_args = args
         return namespace, []
 
@@ -161,6 +163,14 @@ def __call__(self, parser, namespace, value, option_string=None):
     """)
 msg_actions.add_argument('-F', '--file', help=argparse.SUPPRESS)
 msg_actions.add_argument('-t', '--template', help=argparse.SUPPRESS)
+msg_actions.add_argument(
+    '-e', '--edit', action='store_true',
+    help='force edit of commit',
+    docs="""
+        The message taken from command line with -m, and from automatically
+        generated one are usually used as the commit log message unmodified.
+        This option lets you further edit the message taken from these sources.
+    """)
 
 add_actions = commit_opts.add_mutually_exclusive_group()
 add_actions.add_argument(

tests/scripts/test_pkgdev_commit.py

@@ -84,6 +84,8 @@ def test_git_commit_args(self, repo, make_git_repo, tool):
                     ('--dry-run', '--dry-run'),
                     ('-v', '-v'),
                     ('--verbose', '-v'),
+                    ('-e', '--edit'),
+                    ('--edit', '--edit'),
                     ):
                 options, _ = tool.parse_args(['commit', opt])
                 assert expected in options.commit_args
@@ -94,7 +96,7 @@ def test_git_commit_args_passthrough(self, repo, make_git_repo, tool):
         repo.create_ebuild('cat/pkg-0')
         git_repo.add_all('cat/pkg-0', commit=False)
         with chdir(repo.location):
-            for opt in ('--author="A U Thor <author@example.com>"', '-e'):
+            for opt in ('--author="A U Thor <author@example.com>"', '-p'):
                 options, _ = tool.parse_args(['commit', opt])
             assert options.commit_args == [opt]