| Message ID | 20220911172608.2542076-3-alex@linutronix.de |
|---|---|
| State | New |
| Headers | show |
| Series | [1/5] ref-manual: correct the location of default configuration template | expand |
Hi Alex, On 9/11/22 19:26, Alexander Kanavin wrote: > Signed-off-by: Alexander Kanavin <alex@linutronix.de> > --- > documentation/dev-manual/common-tasks.rst | 11 +++++++++++ > 1 file changed, 11 insertions(+) > > diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst > index c2afec946..4d19bd921 100644 > --- a/documentation/dev-manual/common-tasks.rst > +++ b/documentation/dev-manual/common-tasks.rst > @@ -728,6 +728,17 @@ The following list describes the available commands: > > - ``create-layer``: Creates a basic layer. > > +- ``save-build-conf``: Saves the currently active build configuration > + (conf/local.conf, conf/bblayers.conf) as a template into a layer. Double tick-quote the paths please, e.g.: ``conf/local.conf`` > + This template can later be used for setting up builds via TEMPLATECONF. :term:`TEMPLATECONF` > + For information about saving and usinc configuration templates, see s/usinc/using/ > + ":ref:`dev-manual/common-tasks:creating a custom template configuration directory`". > + > +- ``create-layers-setup``: Writes out a configuration file and/or a script that > + can replicate the directory structure and revisions of the layers in a current build. > + For more information, see ":ref:`dev-manual/common-tasks:saving and restoring the layers setup`". > + Should we order alphabetically the list of available commands? Cheers, Quentin
I'm not sure alphabetical order makes sense. There is a certain logical order in describing the commands that follows a typical 'setting up a build and configuration' workflow, and that is perhaps better. In any case, that should be a separate commit, as reordering things should always be kept separate from modifying them. Thanks for all the fixups! Alex On Tue, 20 Sept 2022 at 22:28, Michael Opdenacker <michael.opdenacker@bootlin.com> wrote: > > Quentin, Alex, > > Thanks for the patch and review. > > On 19.09.22 17:23, Quentin Schulz via lists.yoctoproject.org wrote: > > Hi Alex, > > > > On 9/11/22 19:26, Alexander Kanavin wrote: > >> Signed-off-by: Alexander Kanavin <alex@linutronix.de> > >> --- > >> documentation/dev-manual/common-tasks.rst | 11 +++++++++++ > >> 1 file changed, 11 insertions(+) > >> > >> diff --git a/documentation/dev-manual/common-tasks.rst > >> b/documentation/dev-manual/common-tasks.rst > >> index c2afec946..4d19bd921 100644 > >> --- a/documentation/dev-manual/common-tasks.rst > >> +++ b/documentation/dev-manual/common-tasks.rst > >> @@ -728,6 +728,17 @@ The following list describes the available > >> commands: > >> - ``create-layer``: Creates a basic layer. > >> +- ``save-build-conf``: Saves the currently active build > >> configuration > >> + (conf/local.conf, conf/bblayers.conf) as a template into a layer. > > > > Double tick-quote the paths please, e.g.: > > ``conf/local.conf`` > > > >> + This template can later be used for setting up builds via > >> TEMPLATECONF. > > > > :term:`TEMPLATECONF` > > > >> + For information about saving and usinc configuration templates, see > > > > s/usinc/using/ > > > >> + ":ref:`dev-manual/common-tasks:creating a custom template > >> configuration directory`". > >> + > >> +- ``create-layers-setup``: Writes out a configuration file and/or a > >> script that > >> + can replicate the directory structure and revisions of the layers > >> in a current build. > >> + For more information, see ":ref:`dev-manual/common-tasks:saving > >> and restoring the layers setup`". > >> + > > > I took your review into account, Quentin. > > > > > Should we order alphabetically the list of available commands? > > > Maybe, this should be another change, as the commands are not sorted > alphabetically in the existing text. At least, I modified Alex' changes > to insert them in a way that is consistent with the order in the > "--help" output. > > I agree though that sorting commands alphabetically would help, in the > documentation, but in the code too. Would the latter make sense? > > Anyway, I merged this change into master-next. I had to apply the 4/5 > patch first, otherwise, this one was making a reference to a chapter > that didn't exist yet. > > Thanks again! > Michael. > > -- > Michael Opdenacker, Bootlin > Embedded Linux and Kernel engineering > https://bootlin.com >
diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst index c2afec946..4d19bd921 100644 --- a/documentation/dev-manual/common-tasks.rst +++ b/documentation/dev-manual/common-tasks.rst @@ -728,6 +728,17 @@ The following list describes the available commands: - ``create-layer``: Creates a basic layer. +- ``save-build-conf``: Saves the currently active build configuration + (conf/local.conf, conf/bblayers.conf) as a template into a layer. + This template can later be used for setting up builds via TEMPLATECONF. + For information about saving and usinc configuration templates, see + ":ref:`dev-manual/common-tasks:creating a custom template configuration directory`". + +- ``create-layers-setup``: Writes out a configuration file and/or a script that + can replicate the directory structure and revisions of the layers in a current build. + For more information, see ":ref:`dev-manual/common-tasks:saving and restoring the layers setup`". + + Creating a General Layer Using the ``bitbake-layers`` Script ------------------------------------------------------------
Signed-off-by: Alexander Kanavin <alex@linutronix.de> --- documentation/dev-manual/common-tasks.rst | 11 +++++++++++ 1 file changed, 11 insertions(+)