grub2/README.do-rebase
Leo Sandoval 9eb852fbc5 do-rebase: refactor command line parameters
Removes the logic to search for a distro release version based on the --dist
argument and instead makes this as required parameter provided by the
user, reducing code size considerably as the expense of letting the user
responsibility to define it. The --dist argument was also used as branch
name in some cases (where --dist was not defined) so this change splits the
original parameter semantic in two: one for defining the distro release
version (--dist) and another to define the branch name (--branch). Finally, a
short README with single scenario as example.

Signed-off-by: Leo Sandoval <lsandova@redhat.com>
2024-10-23 18:34:24 -06:00

21 lines
1.2 KiB
Text

do-rebase script
================
The `do-rebase` is a useful script that helps the developers to take patches from
a remote repository & branch, apply those and create a commit. Although this sounds like
easy steps, each may take time and it is prone to errors (as any manual work).
To see in action, supposed you have a one or more patches for `f42` release that fixes (or
enhances) a bug at the repository `git@github.com:someuser/grub2.git` with branch
name `hotfix`; the way to call the script is by
$ ./do-rebase --dist=f42 --repo=git@github.com:someuser/grub2.git --branch=hotfix
the script will then fetch the repository in a separate directory (`.rhboot.git`), compare
those `hotfix` commits that has not been merged in `master` (`git format-patch master..hotfix`
on the `.rhboot.git` repo), replace these with the ones in current working dir, finally create
a commit that you can of course amend.
The script supports other useful options: `--amend --commit --nocommit --bumpspec --nobumpspec --pkgtool=<PACKAGE_TOOL>`.
Worth mentioning that you do not have to specify a --pkgtool option: it is infered from the --dist parameter but in
case you want to override it, the options is there.