Message ID | 20211203173955.77512-1-foss@0leil.net |
---|---|
State | Accepted |
Commit | 2b171d267ae37d467f8437c4739f32e5253049b3 |
Headers | show |
Series | docs: dev-manual: common-tasks: highlight creating your own layer is not required | expand |
Hi Quentin, On 12/3/21 6:39 PM, Quentin Schulz wrote: > Three's been some feedback saying that people actually missed that > paragraph and thought creating the layer by hand was the only way to do > it instead of leveraging bitbake-layers create-layer tool. > > Let's try to make it a bit more obvious one does not need to create the > layer by hand by putting the paragraph into a note. > > Signed-off-by: Quentin Schulz <foss@0leil.net> > --- > documentation/dev-manual/common-tasks.rst | 20 +++++++++++--------- > 1 file changed, 11 insertions(+), 9 deletions(-) > > diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst > index 3eead147a..2f5a02f4c 100644 > --- a/documentation/dev-manual/common-tasks.rst > +++ b/documentation/dev-manual/common-tasks.rst > @@ -24,15 +24,17 @@ section in the Yocto Project Overview and Concepts Manual. > Creating Your Own Layer > ----------------------- > > -It is very easy to create your own layers to use with the OpenEmbedded > -build system, as the Yocto Project ships with tools that speed up creating > -layers. This section describes the steps you perform by hand to create > -layers so that you can better understand them. For information about the > -layer-creation tools, see the > -":ref:`bsp-guide/bsp:creating a new bsp layer using the \`\`bitbake-layers\`\` script`" > -section in the Yocto Project Board Support Package (BSP) Developer's > -Guide and the ":ref:`dev-manual/common-tasks:creating a general layer using the \`\`bitbake-layers\`\` script`" > -section further down in this manual. > +.. note:: > + > + It is very easy to create your own layers to use with the OpenEmbedded > + build system, as the Yocto Project ships with tools that speed up creating > + layers. This section describes the steps you perform by hand to create > + layers so that you can better understand them. For information about the > + layer-creation tools, see the > + ":ref:`bsp-guide/bsp:creating a new bsp layer using the \`\`bitbake-layers\`\` script`" > + section in the Yocto Project Board Support Package (BSP) Developer's > + Guide and the ":ref:`dev-manual/common-tasks:creating a general layer using the \`\`bitbake-layers\`\` script`" > + section further down in this manual. > > Follow these general steps to create your layer without using tools: Thanks for the patch. Good idea. Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> ... and merged into "master-next". 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 3eead147a..2f5a02f4c 100644 --- a/documentation/dev-manual/common-tasks.rst +++ b/documentation/dev-manual/common-tasks.rst @@ -24,15 +24,17 @@ section in the Yocto Project Overview and Concepts Manual. Creating Your Own Layer ----------------------- -It is very easy to create your own layers to use with the OpenEmbedded -build system, as the Yocto Project ships with tools that speed up creating -layers. This section describes the steps you perform by hand to create -layers so that you can better understand them. For information about the -layer-creation tools, see the -":ref:`bsp-guide/bsp:creating a new bsp layer using the \`\`bitbake-layers\`\` script`" -section in the Yocto Project Board Support Package (BSP) Developer's -Guide and the ":ref:`dev-manual/common-tasks:creating a general layer using the \`\`bitbake-layers\`\` script`" -section further down in this manual. +.. note:: + + It is very easy to create your own layers to use with the OpenEmbedded + build system, as the Yocto Project ships with tools that speed up creating + layers. This section describes the steps you perform by hand to create + layers so that you can better understand them. For information about the + layer-creation tools, see the + ":ref:`bsp-guide/bsp:creating a new bsp layer using the \`\`bitbake-layers\`\` script`" + section in the Yocto Project Board Support Package (BSP) Developer's + Guide and the ":ref:`dev-manual/common-tasks:creating a general layer using the \`\`bitbake-layers\`\` script`" + section further down in this manual. Follow these general steps to create your layer without using tools:
Three's been some feedback saying that people actually missed that paragraph and thought creating the layer by hand was the only way to do it instead of leveraging bitbake-layers create-layer tool. Let's try to make it a bit more obvious one does not need to create the layer by hand by putting the paragraph into a note. Signed-off-by: Quentin Schulz <foss@0leil.net> --- documentation/dev-manual/common-tasks.rst | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-)