Re: [docs] [PATCH 1/2] bitbake-setup: rename "abort" rebase conflict stragegy to "halt"

[Richard Purdie <richard.purdie@linuxfoundation.org>]

On Tue, 2026-03-31 at 11:00 +0200, Quentin Schulz via lists.yoctoproject.org wrote:
> Hi Antonin,
> 
> On 3/31/26 10:14 AM, Antonin Godard via lists.yoctoproject.org wrote:
> > As per [1], do not use the word "abort" and replace it with "halt" for
> > the rebase conflicts strategy. This is something we try to follow in our
> > documentation.
> > 
> > [1]: https://inclusivenaming.org/word-lists/tier-1/abort/
> > 
> > Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
> > ---
> >   bin/bitbake-setup                                                 | 8 ++++----
> >   doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst | 6 +++---
> >   doc/bitbake-user-manual/bitbake-user-manual-fetching.rst          | 2 +-
> >   lib/bb/tests/setup.py                                             | 8 ++++----
> >   4 files changed, 12 insertions(+), 12 deletions(-)
> > 
> > diff --git a/bin/bitbake-setup b/bin/bitbake-setup
> > index b02cbc2b1c4..33cbefb4914 100755
> > --- a/bin/bitbake-setup
> > +++ b/bin/bitbake-setup
> > @@ -167,7 +167,7 @@ def _get_remotes(r_remote):
> >   
> >       return remotes
> >   
> > -def checkout_layers(layers, confdir, layerdir, d, rebase_conflicts_strategy='abort'):
> > +def checkout_layers(layers, confdir, layerdir, d, rebase_conflicts_strategy='halt'):
> >       def _checkout_git_remote(r_remote, repodir, layers_fixed_revisions):
> >           rev = r_remote['rev']
> >           branch = r_remote.get('branch', None)
> > @@ -458,7 +458,7 @@ def merge_overrides_into_sources(sources, overrides):
> >               layers[k] = v
> >       return layers
> >   
> > -def update_build(config, confdir, setupdir, layerdir, d, update_bb_conf="prompt", init_vscode=False, rebase_conflicts_strategy='abort'):
> > +def update_build(config, confdir, setupdir, layerdir, d, update_bb_conf="prompt", init_vscode=False, rebase_conflicts_strategy='halt'):
> >       layer_config = merge_overrides_into_sources(config["data"]["sources"], config["source-overrides"]["sources"])
> >       sources_fixed_revisions = checkout_layers(layer_config, confdir, layerdir, d, rebase_conflicts_strategy=rebase_conflicts_strategy)
> >       bitbake_config = config["bitbake-config"]
> > @@ -1273,9 +1273,9 @@ def main():
> >       parser_update = subparsers.add_parser('update', help='Update a setup to be in sync with configuration')
> >       add_setup_dir_arg(parser_update)
> >       parser_update.add_argument('--update-bb-conf', choices=['prompt', 'yes', 'no'], default='prompt', help='Update bitbake configuration files (bblayers.conf, local.conf) (default: prompt)')
> > -    parser_update.add_argument('--rebase-conflicts-strategy', choices=['abort', 'backup'], default='abort',
> > +    parser_update.add_argument('--rebase-conflicts-strategy', choices=['halt', 'backup'], default='halt',
> >                           help="What to do when a layer repository has local modifications that prevent "
> > -                             "an in-place update: 'abort' (default) aborts with an error message; "
> > +                             "an in-place update: 'halt' (default) halts with an error message; "
> >                                "'backup' renames the directory to a timestamped backup and re-clones from upstream.")
> >       parser_update.set_defaults(func=build_update)
> >   
> > diff --git a/doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst b/doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst
> > index c22e19bd665..c7b73001404 100644
> > --- a/doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst
> > +++ b/doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst
> > @@ -458,9 +458,9 @@ In addition, the command can take the following arguments:
> >      local modifications or commits that prevent an in-place update. Accepted
> >      values are:
> >   
> > -   -  ``abort`` (default): stop with an error message describing the problem.
> > +   -  ``halt`` (default): stop with an error message describing the problem.
> >         The repository is left in its previous state (the failed rebase is
> > -      automatically aborted). The error message includes a hint to re-run with
> > +      automatically halted). The error message includes a hint to re-run with
> 
> This is not what halt means. Maybe 'reset' would be a better choice? Or 
> if you really want to follow the recommendations from that website, I
> guess "cancel"?

The trouble is none of these alternatives really match what abort
means, reset and cancel do mean something different. "abandon" might be
closer but still isn't right. "attempt" maybe? If we get too creative
with this, users just won't understand what it means :(

Cheers,

Richard