Skip to content

Commit 27a32bf

Browse files
committed
script/ptl-tool: organize options and improve help output
Signed-off-by: Patrick Donnelly <[email protected]>
1 parent dd741e7 commit 27a32bf

File tree

1 file changed

+34
-22
lines changed

1 file changed

+34
-22
lines changed

src/script/ptl-tool.py

Lines changed: 34 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -580,28 +580,40 @@ def main():
580580
default_label = False
581581
else:
582582
argv = sys.argv[1:]
583-
parser.add_argument('--base', dest='base', action='store', default=default_base, help='base for branch')
584-
parser.add_argument('--branch', dest='branch', action='store', default=default_branch, help='branch to create ("HEAD" leaves HEAD detached; i.e. no branch is made)')
585-
parser.add_argument('--branch-release', dest='branch_release', action='store', help='release name to embed in branch (for shaman)')
586-
parser.add_argument('--create-qa', dest='create_qa', action='store_true', help='create QA run ticket')
587-
parser.add_argument('--debug', dest='debug', action='store_true', help='turn debugging on')
588-
parser.add_argument('--distros', dest='distros', action=SplitCommaAppendAction, default=[], help='add distro(s) to build. Specify one or more times. Comma separated values are split.')
589-
parser.add_argument('--archs', dest='archs', action=SplitCommaAppendAction, default=[], help='add arch(s) to build. Specify one or more times. Comma separated values are split.')
590-
parser.add_argument('--flavors', dest='flavors', action=SplitCommaAppendAction, default=[], help='add flavors(s) to build. Specify one or more times. Comma separated values are split.')
591-
parser.add_argument('--debug-build', dest='debug_build', action='store_true', help='append -debug to branch name prompting ceph-build to build with CMAKE_BUILD_TYPE=Debug')
592-
parser.add_argument('--branch-name-append', dest='branch_append', action='store', help='append string to branch name')
593-
parser.add_argument('--git-dir', dest='git', action='store', default=git_dir, help='git directory')
594-
parser.add_argument('--label', dest='label', action='store', default=default_label, help='label PRs for testing')
595-
parser.add_argument('--merge-branch-name', dest='merge_branch_name', action='store', default=False, help='name of the branch for merge messages')
596-
parser.add_argument('--no-credits', dest='credits', action='store_false', help='skip indication search (Reviewed-by, etc.)')
597-
parser.add_argument('--pr-label', dest='pr_label', action='store', help='label PRs for testing')
598-
parser.add_argument('--qa-release', dest='qa_release', action='store', help='QA release for tracker')
599-
parser.add_argument('--qa-tags', dest='qa_tags', action='store', help='QA tags for tracker')
600-
parser.add_argument('--stop-at-built', dest='stop_at_built', action='store_true', help='stop execution when branch is built')
601-
parser.add_argument('--update-qa', dest='update_qa', action='store', help='update QA run ticket')
602-
parser.add_argument('--no-push-ci', dest='no_push_ci', action='store_true',
603-
help='don\'t push branch to ceph-ci repo')
604-
parser.add_argument('prs', metavar="PR", type=int, nargs='*', help='Pull Requests to merge')
583+
584+
group = parser.add_argument_group('General Options')
585+
group.add_argument('--debug', dest='debug', action='store_true', help='turn debugging on')
586+
group.add_argument('--git-dir', dest='git', action='store', default=git_dir, help='git directory')
587+
588+
group = parser.add_argument_group('GitHub PR Options')
589+
group.add_argument('--label', dest='label', action='store', default=default_label, help='label PRs for testing')
590+
group.add_argument('--pr-label', dest='pr_label', action='store', help='source PRs to merge via label')
591+
592+
group = parser.add_argument_group('Branch Control Options')
593+
group.add_argument('--base', dest='base', action='store', default=default_base, help='base for branch')
594+
group.add_argument('--branch', dest='branch', action='store', default=default_branch, help='branch to create ("HEAD" leaves HEAD detached; i.e. no branch is made)')
595+
group.add_argument('--branch-name-append', dest='branch_append', action='store', help='append string to branch name')
596+
group.add_argument('--branch-release', dest='branch_release', action='store', help='release name to embed in branch (for shaman)')
597+
group.add_argument('--merge-branch-name', dest='merge_branch_name', action='store', default=False, help='name of the branch for merge messages')
598+
group.add_argument('--no-credits', dest='credits', action='store_false', help='skip indication search (Reviewed-by, etc.)')
599+
group.add_argument('--stop-at-built', dest='stop_at_built', action='store_true', help='stop execution when branch is built')
600+
601+
group = parser.add_argument_group('Build Control Options')
602+
group.add_argument('--archs', dest='archs', action=SplitCommaAppendAction, default=[], help='add arch(s) to build. Specify one or more times. Comma separated values are split.')
603+
group.add_argument('--debug-build', dest='debug_build', action='store_true', help='append -debug to branch name prompting ceph-build to build with CMAKE_BUILD_TYPE=Debug')
604+
group.add_argument('--distros', dest='distros', action=SplitCommaAppendAction, default=[], help='add distro(s) to build. Specify one or more times. Comma separated values are split.')
605+
group.add_argument('--flavors', dest='flavors', action=SplitCommaAppendAction, default=[], help='add flavors(s) to build. Specify one or more times. Comma separated values are split.')
606+
group.add_argument('--no-push-ci', dest='no_push_ci', action='store_true', help='don\'t push branch to ceph-ci repo')
607+
608+
group = parser.add_argument_group('QA Control Options')
609+
group.add_argument('--create-qa', dest='create_qa', action='store_true', help='create QA run ticket')
610+
group.add_argument('--qa-release', dest='qa_release', action='store', help='QA release for tracker')
611+
group.add_argument('--qa-tags', dest='qa_tags', action='store', help='QA tags for tracker')
612+
group.add_argument('--update-qa', dest='update_qa', action='store', help='update QA run ticket')
613+
614+
group = parser.add_argument_group('PRs to Merge')
615+
group.add_argument('prs', metavar="PRs...", type=int, nargs='*', help='Pull Requests to Merge')
616+
605617
args = parser.parse_args(argv)
606618

607619
if args.create_qa and args.update_qa:

0 commit comments

Comments
 (0)