[1/3] common-tasks: Add a summary to the end of the bbappend example

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

Details

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

Commit Message

Tom Rini Aug. 12, 2021, 4:10 p.m.
Try and make it clearer what the final result of this bbappend example
is.

Signed-off-by: Tom Rini <trini@konsulko.com>
---
 documentation/dev-manual/common-tasks.rst | 6 ++++++
 1 file changed, 6 insertions(+)

Patch hide | download patch | download mbox

diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst
index 37077d72d451..2d8ef96e2600 100644
--- a/documentation/dev-manual/common-tasks.rst
+++ b/documentation/dev-manual/common-tasks.rst
@@ -545,6 +545,12 @@  important as it ensures that items in the list remain colon-separated.
    allow to add build options (e.g. ``systemd``). For these cases, your
    append file would not even use the :term:`FILESEXTRAPATHS` statement.
 
+The end result of this ``.bbappend`` file is that on a Raspberry Pi, where
+``rpi`` will exist in the list of :term:`OVERRIDES`, the file
+``meta-raspberrypi/recipes-bsp/formfactor/formfactor/rpi/machconfig`` will be
+used during ``do_fetch`` and the test for a non-zero file size in
+``do_install`` will return true, and the file will be installed.
+
 Prioritizing Your Layer
 -----------------------
 

Comments

Michael Opdenacker Aug. 13, 2021, 8:16 a.m.
Hi Tom,

On 8/12/21 6:10 PM, Tom Rini wrote:
> Try and make it clearer what the final result of this bbappend example
> is.
>
> Signed-off-by: Tom Rini <trini@konsulko.com>
> ---
>  documentation/dev-manual/common-tasks.rst | 6 ++++++
>  1 file changed, 6 insertions(+)
>
> diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst
> index 37077d72d451..2d8ef96e2600 100644
> --- a/documentation/dev-manual/common-tasks.rst
> +++ b/documentation/dev-manual/common-tasks.rst
> @@ -545,6 +545,12 @@ important as it ensures that items in the list remain colon-separated.
>     allow to add build options (e.g. ``systemd``). For these cases, your
>     append file would not even use the :term:`FILESEXTRAPATHS` statement.
>  
> +The end result of this ``.bbappend`` file is that on a Raspberry Pi, where
> +``rpi`` will exist in the list of :term:`OVERRIDES`, the file
> +``meta-raspberrypi/recipes-bsp/formfactor/formfactor/rpi/machconfig`` will be
> +used during ``do_fetch`` and the test for a non-zero file size in
> +``do_install`` will return true, and the file will be installed.


I agree that this text really helps to understand this section. I was
confused otherwise.

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

Thanks again,
Michael.
Quentin Schulz Aug. 13, 2021, 8:21 a.m.
Hi Tom,

Thanks for sending the patch :)


On Thu, Aug 12, 2021 at 12:10:25PM -0400, Tom Rini wrote:
> is.
> 
> Signed-off-by: Tom Rini <trini@konsulko.com>
> ---
>  documentation/dev-manual/common-tasks.rst | 6 ++++++
>  1 file changed, 6 insertions(+)
> 
> diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst
> index 37077d72d451..2d8ef96e2600 100644
> --- a/documentation/dev-manual/common-tasks.rst
> +++ b/documentation/dev-manual/common-tasks.rst
> @@ -545,6 +545,12 @@ important as it ensures that items in the list remain colon-separated.
>     allow to add build options (e.g. ``systemd``). For these cases, your
>     append file would not even use the :term:`FILESEXTRAPATHS` statement.
>  
> +The end result of this ``.bbappend`` file is that on a Raspberry Pi, where
> +``rpi`` will exist in the list of :term:`OVERRIDES`, the file
> +``meta-raspberrypi/recipes-bsp/formfactor/formfactor/rpi/machconfig`` will be
> +used during ``do_fetch`` and the test for a non-zero file size in

s/``do_fetch``/:ref:`ref-tasks-fetch`/

> +``do_install`` will return true, and the file will be installed.
> +

s/``do_install``/:ref:`ref-tasks-install`/

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

Thanks!
Quentin
-=-=-=-=-=-=-=-=-=-=-=-
Links: You receive all messages sent to this group.
View/Reply Online (#1688): https://lists.yoctoproject.org/g/docs/message/1688
Mute This Topic: https://lists.yoctoproject.org/mt/84843448/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, 8:28 a.m.
Hi Quentin,

Thanks for the review!

On 8/13/21 10:21 AM, Quentin Schulz wrote:

> s/``do_fetch``/:ref:`ref-tasks-fetch`/
>
>> +``do_install`` will return true, and the file will be installed.
>> +
> s/``do_install``/:ref:`ref-tasks-install`/


Good catch! I see other places in the documentation where this could be
done. I'll add it to my TODO list, but be my guest if you have time.

I updated the commit in master-next.
Cheers,
Michael.
Quentin Schulz Aug. 13, 2021, 8:31 a.m.
On Fri, Aug 13, 2021 at 10:28:39AM +0200, Michael Opdenacker wrote:
> Hi Quentin,
> 
> Thanks for the review!
> 
> On 8/13/21 10:21 AM, Quentin Schulz wrote:
> 
> > s/``do_fetch``/:ref:`ref-tasks-fetch`/
> >
> >> +``do_install`` will return true, and the file will be installed.
> >> +
> > s/``do_install``/:ref:`ref-tasks-install`/
> 
> 
> Good catch! I see other places in the documentation where this could be
> done. I'll add it to my TODO list, but be my guest if you have time.
> 

You can open a Bugzilla entry for this so we don't forget :)

We probably need to do the same for classes, tasks and variables. I saw
I missed a few variables that aren't highlighted with tick quotes in the
docs, which explains why they were missed by the script :)

Cheers,
Quentin
-=-=-=-=-=-=-=-=-=-=-=-
Links: You receive all messages sent to this group.
View/Reply Online (#1692): https://lists.yoctoproject.org/g/docs/message/1692
Mute This Topic: https://lists.yoctoproject.org/mt/84843448/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, 8:48 a.m.
On 8/13/21 10:31 AM, Quentin Schulz wrote:
> You can open a Bugzilla entry for this so we don't forget :)
>
> We probably need to do the same for classes, tasks and variables. I saw
> I missed a few variables that aren't highlighted with tick quotes in the
> docs, which explains why they were missed by the script :)


Good idea. Anyway, I'm one of the people with the greatest number of bugs.
Here it is: https://bugzilla.yoctoproject.org/show_bug.cgi?id=14508

Thanks again
Michael.