From bed48440704c87dd5ab0003fd630f51e74eee173 Mon Sep 17 00:00:00 2001 From: Hans Ulrich Niedermann Date: Thu, 5 Aug 2010 12:34:34 +0200 Subject: doc improvements --- src/pyfedpkg/initial_merge.py | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/src/pyfedpkg/initial_merge.py b/src/pyfedpkg/initial_merge.py index 9ebf66e..28e922e 100755 --- a/src/pyfedpkg/initial_merge.py +++ b/src/pyfedpkg/initial_merge.py @@ -1,19 +1,18 @@ #!/usr/bin/python -"""initial_merge.py - perform initial merge after dist-git migration +# initial_merge.py - perform initial merge after dist-git migration -initial_merge.py performs a merge of all git branches with the same -content in the directory tree, i.e. with the same packages. +"""\ +"fedpkg initial-merge" performs a merge of all git branches with the same +content in the directory tree, i.e. with the same package spec files, +patches, etc. This is useful after Fedora's dist-cvs to dist-git migration, as often different branches have different histories but the same content on the filesystem. -After these merges, future merges between the branches will be a lot -easier. - -Note that this also works as a standalone script which calls fedpkg -via subprocess.Popen, as fedpkg has a bunch of issues with changing -CWD. +After these initial merges of identical trees, future merges between +the branches will be a lot easier: Easier to follow in the dependency +graph, and easier to perform without conflicts. """ import argparse @@ -191,13 +190,15 @@ def fedpkg_command(args): for repo in args.repos: handle_path(repo) +_module_doc = __doc__ def get_parser(subparsers): sp = subparsers.add_parser('initial-merge', - help = 'Do initial-git merge joining branches with identical trees') + help = 'git merge to join branches with identical trees', + epilog = _module_doc) sp.add_argument('repos', metavar='repo-path', nargs='*', default=['.'], action=Action, - help = 'The directories with the repos to initial-merge') + help = 'Path to a repo to initial-merge') sp.set_defaults(command = fedpkg_command) return sp -- cgit