[2/3] manuals: Rename the "Using .bbappend Files in Your Layer" section

Submitted by Tom Rini on Aug. 12, 2021, 4:10 p.m. | Patch ID: 180055

Details

Message ID 20210812161027.580-2-trini@konsulko.com
State New
Headers show

Commit Message

Tom Rini Aug. 12, 2021, 4:10 p.m.
To prepare to add another example bbappend, rename the current "Using
.bbappend Files in Your Layer" section to "Appending Other Layers With
Your Layer".  Name the current example as "Overlaying a File Using Your
Layer".

Signed-off-by: Tom Rini <trini@konsulko.com>
---
 documentation/dev-manual/common-tasks.rst        | 9 ++++++---
 documentation/kernel-dev/common.rst              | 4 ++--
 documentation/kernel-dev/faq.rst                 | 2 +-
 documentation/migration-guides/migration-1.4.rst | 2 +-
 4 files changed, 10 insertions(+), 7 deletions(-)

Patch hide | download patch | download mbox

diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst
index 2d8ef96e2600..f15e72887c04 100644
--- a/documentation/dev-manual/common-tasks.rst
+++ b/documentation/dev-manual/common-tasks.rst
@@ -443,8 +443,8 @@  file. During the processing of each ``conf/layer.conf`` file, BitBake
 adds the recipes, classes and configurations contained within the
 particular layer to the source directory.
 
-Using .bbappend Files in Your Layer
------------------------------------
+Appending Other Layers With Your Layer
+--------------------------------------
 
 A recipe that appends Metadata to another recipe is called a BitBake
 append file. A BitBake append file uses the ``.bbappend`` file type
@@ -474,6 +474,9 @@  does not have a corresponding recipe with a matching name. See the
 :term:`BB_DANGLINGAPPENDS_WARNONLY`
 variable for information on how to handle this error.
 
+Overlaying a File Using Your Layer
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
 As an example, consider the main formfactor recipe and a corresponding
 formfactor append file both from the :term:`Source Directory`.
 Here is the main
@@ -6091,7 +6094,7 @@  layer. The following steps provide some more detail:
 
    -  Add a ``psplash`` append file for a branded splash screen. For
       information on append files, see the
-      ":ref:`dev-manual/common-tasks:using .bbappend files in your layer`"
+      ":ref:`dev-manual/common-tasks:appending other layers with your layer`"
       section.
 
    -  Add any other append files to make custom changes that are
diff --git a/documentation/kernel-dev/common.rst b/documentation/kernel-dev/common.rst
index a97140b0b904..e0bc375f8247 100644
--- a/documentation/kernel-dev/common.rst
+++ b/documentation/kernel-dev/common.rst
@@ -425,7 +425,7 @@  home directory:
    The :term:`FILESEXTRAPATHS` and :term:`SRC_URI` statements
    enable the OpenEmbedded build system to find patch files. For more
    information on using append files, see the
-   ":ref:`dev-manual/common-tasks:using .bbappend files in your layer`"
+   ":ref:`dev-manual/common-tasks:appending other layers with your layer`"
    section in the Yocto Project Development Tasks Manual.
 
 Modifying an Existing Recipe
@@ -1070,7 +1070,7 @@  Section.
    For more information on append files and patches, see the
    ":ref:`kernel-dev/common:creating the append file`" and
    ":ref:`kernel-dev/common:applying patches`" sections. You can also see the
-   ":ref:`dev-manual/common-tasks:using .bbappend files in your layer`"
+   ":ref:`dev-manual/common-tasks:appending other layers with your layer`"
    section in the Yocto Project Development Tasks Manual.
 
    .. note::
diff --git a/documentation/kernel-dev/faq.rst b/documentation/kernel-dev/faq.rst
index f0a7af37bb0b..2497145f26aa 100644
--- a/documentation/kernel-dev/faq.rst
+++ b/documentation/kernel-dev/faq.rst
@@ -38,7 +38,7 @@  The kernel image (e.g. ``vmlinuz``) is provided by the
 specify whether or not the kernel image is installed in the generated
 root filesystem, override ``RDEPENDS_${KERNEL_PACKAGE_NAME}-base`` to include or not
 include "kernel-image". See the
-":ref:`dev-manual/common-tasks:using .bbappend files in your layer`"
+":ref:`dev-manual/common-tasks:appending other layers with your layer`"
 section in the
 Yocto Project Development Tasks Manual for information on how to use an
 append file to override metadata.
diff --git a/documentation/migration-guides/migration-1.4.rst b/documentation/migration-guides/migration-1.4.rst
index 3f980915cf0c..81e8ccd03ba3 100644
--- a/documentation/migration-guides/migration-1.4.rst
+++ b/documentation/migration-guides/migration-1.4.rst
@@ -83,7 +83,7 @@  create an append file for the ``init-ifupdown`` recipe instead, which
 you can find in the :term:`Source Directory` at
 ``meta/recipes-core/init-ifupdown``. For information on how to use
 append files, see the
-":ref:`dev-manual/common-tasks:using .bbappend files in your layer`"
+":ref:`dev-manual/common-tasks:appending other layers with your layer`"
 section in the Yocto Project Development Tasks Manual.
 
 .. _migration-1.4-remote-debugging:

Comments

Quentin Schulz Aug. 13, 2021, 8:29 a.m.
Hi Tom,

On Thu, Aug 12, 2021 at 12:10:26PM -0400, Tom Rini wrote:
> .bbappend Files in Your Layer" section to "Appending Other Layers With
> Your Layer".  Name the current example as "Overlaying a File Using Your
> Layer".
> 
> Signed-off-by: Tom Rini <trini@konsulko.com>
> ---
>  documentation/dev-manual/common-tasks.rst        | 9 ++++++---
>  documentation/kernel-dev/common.rst              | 4 ++--
>  documentation/kernel-dev/faq.rst                 | 2 +-
>  documentation/migration-guides/migration-1.4.rst | 2 +-
>  4 files changed, 10 insertions(+), 7 deletions(-)
> 
> diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst
> index 2d8ef96e2600..f15e72887c04 100644
> --- a/documentation/dev-manual/common-tasks.rst
> +++ b/documentation/dev-manual/common-tasks.rst
> @@ -443,8 +443,8 @@ file. During the processing of each ``conf/layer.conf`` file, BitBake
>  adds the recipes, classes and configurations contained within the
>  particular layer to the source directory.
>  
> -Using .bbappend Files in Your Layer
> ------------------------------------
> +Appending Other Layers With Your Layer
> +--------------------------------------
>  

I could suggest:

Appending Other Layers Metadata With Your Layer

But I think it's fine either way.

Reviewed-by: Quentin Schulz <foss@0leil.net>

Thanks,
Quentin
-=-=-=-=-=-=-=-=-=-=-=-
Links: You receive all messages sent to this group.
View/Reply Online (#1691): https://lists.yoctoproject.org/g/docs/message/1691
Mute This Topic: https://lists.yoctoproject.org/mt/84843449/3617530
Group Owner: docs+owner@lists.yoctoproject.org
Unsubscribe: https://lists.yoctoproject.org/g/docs/unsub [oe-patchwork@oe-patch.openembedded.org]
-=-=-=-=-=-=-=-=-=-=-=-
Michael Opdenacker Aug. 13, 2021, 9:12 a.m.
Hi Tom,

Thanks for the patch!

On 8/13/21 10:29 AM, Quentin Schulz wrote:
> Hi Tom,
>
> On Thu, Aug 12, 2021 at 12:10:26PM -0400, Tom Rini wrote:
>> .bbappend Files in Your Layer" section to "Appending Other Layers With
>> Your Layer".  Name the current example as "Overlaying a File Using Your
>> Layer".
>>
>> Signed-off-by: Tom Rini <trini@konsulko.com>
>> ---
>>  documentation/dev-manual/common-tasks.rst        | 9 ++++++---
>>  documentation/kernel-dev/common.rst              | 4 ++--
>>  documentation/kernel-dev/faq.rst                 | 2 +-
>>  documentation/migration-guides/migration-1.4.rst | 2 +-
>>  4 files changed, 10 insertions(+), 7 deletions(-)
>>
>> diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst
>> index 2d8ef96e2600..f15e72887c04 100644
>> --- a/documentation/dev-manual/common-tasks.rst
>> +++ b/documentation/dev-manual/common-tasks.rst
>> @@ -443,8 +443,8 @@ file. During the processing of each ``conf/layer.conf`` file, BitBake
>>  adds the recipes, classes and configurations contained within the
>>  particular layer to the source directory.
>>  
>> -Using .bbappend Files in Your Layer
>> ------------------------------------
>> +Appending Other Layers With Your Layer
>> +--------------------------------------
>>  
> I could suggest:
>
> Appending Other Layers Metadata With Your Layer
>
> But I think it's fine either way.
>
> Reviewed-by: Quentin Schulz <foss@0leil.net>

I'm taking your proposal, Quentin, thanks!

Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
and merged into "master-next".

Cheers,
Michael.