| Message ID | 20260126222743.411405-2-daiane.angolini@foundries.io |
|---|---|
| State | New |
| Headers | show |
| Series | [docs,1/5] doc: change some terminology around bitbake-setup | expand |
Hi, On Mon Jan 26, 2026 at 11:27 PM CET, Daiane Angolini via lists.yoctoproject.org wrote: > The original output in the script does not use the original terminology > from the document. This patch changes the script output to match the > terminoly, this way user can search the documentation for help. > > Signed-off-by: Daiane Angolini <daiane.angolini@foundries.io> > --- > bin/bitbake-setup | 8 ++++---- > default-registry/configurations/poky-master.conf.json | 2 +- > default-registry/configurations/poky-whinlatter.conf.json | 2 +- > .../bitbake-user-manual-environment-setup.rst | 4 ++-- > 4 files changed, 8 insertions(+), 8 deletions(-) > > diff --git a/bin/bitbake-setup b/bin/bitbake-setup > index abe7614c8..65f0c5eb3 100755 > --- a/bin/bitbake-setup > +++ b/bin/bitbake-setup > @@ -457,11 +457,11 @@ def choose_bitbake_config(configs, parameters, non_interactive): > if non_interactive: > raise Exception("Unable to choose from bitbake configurations in non-interactive mode: {}".format(configs_dict)) > > - logger.plain("\nAvailable bitbake configurations:") > + logger.plain("\nAvailable Variants:") > for n, config_data in enumerated_configs: > logger.plain("{}. {}\t{}".format(n, config_data["name"], config_data["description"])) > config_n = int_input([i[0] for i in enumerated_configs], > - "\nPlease select one of the above bitbake configurations by its number: ") - 1 > + "\nPlease select one of the above Variants by its number: ") - 1 > return flattened_configs[config_n] > > def choose_config(configs, non_interactive): > @@ -475,7 +475,7 @@ def choose_config(configs, non_interactive): > if non_interactive: > raise Exception("Unable to choose from configurations in non-interactive mode: {}".format(not_expired_configs)) > > - logger.plain("\nAvailable configurations:") > + logger.plain("\nAvailable BitBake Setup Template:") s/Template/Templates/ Antonin
On Tue, 27 Jan 2026 at 11:29, Antonin Godard via lists.yoctoproject.org <antonin.godard=bootlin.com@lists.yoctoproject.org> wrote: > > - logger.plain("\nAvailable bitbake configurations:") > > + logger.plain("\nAvailable Variants:") To be honest, I am no longer sure introducing 'variants' as a term is an improvement. Someone well familiar with the terms will get it, someone running the tool for the first time will be baffled. 'bitbake confugurations' is more familiar and straightforward. Alex
diff --git a/bin/bitbake-setup b/bin/bitbake-setup index abe7614c8..65f0c5eb3 100755 --- a/bin/bitbake-setup +++ b/bin/bitbake-setup @@ -457,11 +457,11 @@ def choose_bitbake_config(configs, parameters, non_interactive): if non_interactive: raise Exception("Unable to choose from bitbake configurations in non-interactive mode: {}".format(configs_dict)) - logger.plain("\nAvailable bitbake configurations:") + logger.plain("\nAvailable Variants:") for n, config_data in enumerated_configs: logger.plain("{}. {}\t{}".format(n, config_data["name"], config_data["description"])) config_n = int_input([i[0] for i in enumerated_configs], - "\nPlease select one of the above bitbake configurations by its number: ") - 1 + "\nPlease select one of the above Variants by its number: ") - 1 return flattened_configs[config_n] def choose_config(configs, non_interactive): @@ -475,7 +475,7 @@ def choose_config(configs, non_interactive): if non_interactive: raise Exception("Unable to choose from configurations in non-interactive mode: {}".format(not_expired_configs)) - logger.plain("\nAvailable configurations:") + logger.plain("\nAvailable BitBake Setup Template:") for n, config_name in config_list: config_data = configs[config_name] expiry_date = config_data.get("expires", None) @@ -485,7 +485,7 @@ def choose_config(configs, non_interactive): else: logger.plain("{}. {}\t{}".format(n, config_name, config_desc)) config_n = int_input([i[0] for i in config_list], - "\nPlease select one of the above configurations by its number: ") - 1 + "\nPlease select one of the above BitBake Setup Templates by its number: ") - 1 return config_list[config_n][1] def choose_fragments(possibilities, parameters, non_interactive, skip_selection): diff --git a/default-registry/configurations/poky-master.conf.json b/default-registry/configurations/poky-master.conf.json index 1de038bab..f248a4811 100644 --- a/default-registry/configurations/poky-master.conf.json +++ b/default-registry/configurations/poky-master.conf.json @@ -57,7 +57,7 @@ "options" : ["machine/qemux86-64", "machine/qemuarm64", "machine/qemuriscv64", "machine/genericarm64", "machine/genericx86-64"] }, "distro": { - "description": "Distribution configuration variants", + "description": "Target Distributions", "options" : ["distro/poky", "distro/poky-altcfg", "distro/poky-tiny"] } }, diff --git a/default-registry/configurations/poky-whinlatter.conf.json b/default-registry/configurations/poky-whinlatter.conf.json index bfa67426d..4827ebe11 100644 --- a/default-registry/configurations/poky-whinlatter.conf.json +++ b/default-registry/configurations/poky-whinlatter.conf.json @@ -58,7 +58,7 @@ "options" : ["machine/qemux86-64", "machine/qemuarm64", "machine/qemuriscv64", "machine/genericarm64", "machine/genericx86-64"] }, "distro": { - "description": "Distribution configuration variants", + "description": "Target Distributions", "options" : ["distro/poky", "distro/poky-altcfg", "distro/poky-tiny"] } }, 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 824b01ffb..7bbe7cc75 100644 --- a/doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst +++ b/doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst @@ -347,7 +347,7 @@ In addition, the command can take the following arguments: $ ./bitbake/bin/bitbake-setup init https://git.openembedded.org/bitbake/plain/default-registry/configurations/oe-nodistro-master.conf.json -- This example initializes a :term:`Setup` with: +- This example initializes a :term:`Setup` with: - A custom :ref:`ref-bbsetup-setting-top-dir-prefix` and :ref:`ref-bbsetup-setting-top-dir-name` - A :term:`source override`, and additionally overriding openembedded-core with a locally managed directory. @@ -762,7 +762,7 @@ They contain the following sections: "options" : ["machine/qemux86-64", "machine/qemuarm64", "machine/qemuriscv64", "machine/genericarm64", "machine/genericx86-64"] }, "distro": { - "description": "Distribution configuration variants", + "description": "Target Distributions", "options" : ["distro/poky", "distro/poky-altcfg", "distro/poky-tiny"] } },
The original output in the script does not use the original terminology from the document. This patch changes the script output to match the terminoly, this way user can search the documentation for help. Signed-off-by: Daiane Angolini <daiane.angolini@foundries.io> --- bin/bitbake-setup | 8 ++++---- default-registry/configurations/poky-master.conf.json | 2 +- default-registry/configurations/poky-whinlatter.conf.json | 2 +- .../bitbake-user-manual-environment-setup.rst | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-)