diff mbox series

[docs,3/5] docs: Fix leading text for bitbake-setup init

Message ID 20260126222743.411405-3-daiane.angolini@foundries.io
State New
Headers show
Series [docs,1/5] doc: change some terminology around bitbake-setup | expand

Commit Message

Daiane Angolini Jan. 26, 2026, 10:27 p.m. UTC
If we use the default of bitbake-setut init we may not create anything
(as the first default for an empty directory is N).

If user does not chose a number, the script asks again for a number.

Signed-off-by: Daiane Angolini <daiane.angolini@foundries.io>
---
 .../bitbake-user-manual-environment-setup.rst                   | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Antonin Godard Jan. 27, 2026, 10:29 a.m. UTC | #1
On Mon Jan 26, 2026 at 11:27 PM CET, Daiane Angolini via lists.yoctoproject.org wrote:
> If we use the default of bitbake-setut init we may not create anything
> (as the first default for an empty directory is N).
>
> If user does not chose a number, the script asks again for a number.
>
> Signed-off-by: Daiane Angolini <daiane.angolini@foundries.io>
> ---
>  .../bitbake-user-manual-environment-setup.rst                   | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> 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 7bbe7cc75..e316ead56 100644
> --- a/doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst
> +++ b/doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst
> @@ -50,7 +50,7 @@ Quick Start
>        See the :ref:`ref-bbsetup-section-config-reference` section to learn more
>        about ``bitbake-setup`` input configuration files.
>  
> -#. With the default choices, the ``bitbake-setup init`` command creates the
> +#. One example of ``bitbake-setup init`` possible command creates the
>     following files and directories::
>  
>        ./bitbake-builds/

Reviewed-by: Antonin Godard <antonin.godard@bootlin.com>

Thanks!
Antonin
Alexander Kanavin Jan. 27, 2026, 10:43 a.m. UTC | #2
On Tue, 27 Jan 2026 at 11:29, Antonin Godard via
lists.yoctoproject.org
<antonin.godard=bootlin.com@lists.yoctoproject.org> wrote:
> > -#. With the default choices, the ``bitbake-setup init`` command creates the
> > +#. One example of ``bitbake-setup init`` possible command creates the
> >     following files and directories::

"One example of 'bitbake-setup init' possible command creates ...' is
very clumsy.

Better:
Here is a example of a directory/file tree structure created by
'bitbake-setup init'

Alex
diff mbox series

Patch

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 7bbe7cc75..e316ead56 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst
+++ b/doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst
@@ -50,7 +50,7 @@  Quick Start
       See the :ref:`ref-bbsetup-section-config-reference` section to learn more
       about ``bitbake-setup`` input configuration files.
 
-#. With the default choices, the ``bitbake-setup init`` command creates the
+#. One example of ``bitbake-setup init`` possible command creates the
    following files and directories::
 
       ./bitbake-builds/