Re: [PATCH v2] overview-manual: concepts: add details on package splitting

["Antonin Godard" <antonin.godard@bootlin.com>]

On Tue Oct 22, 2024 at 3:47 PM CEST, Quentin Schulz wrote:
>> -The :term:`FILES` variable defines the
>> -files that go into each package in
>> -:term:`PACKAGES`. If you want
>> -details on how this is accomplished, you can look at
>> -:yocto_git:`package.bbclass </poky/tree/meta/classes-global/package.bbclass>`.
>> +Packages for a recipe are listed in the :term:`PACKAGES` variable. The
>> +:oe_git:`bitbake.conf </openembedded-core/tree/meta/conf/bitbake.conf>`
>> +configuration file defines the following default list of packages::
>> +
>> +  PACKAGES = "${PN}-src ${PN}-dbg ${PN}-staticdev ${PN}-dev ${PN}-doc ${PN}-locale ${PACKAGE_BEFORE_PN} ${PN}"
>> +
>> +Each of these packages contain a default list of files defined with the
>
> s/contain/contains/ since it's "each" so singular.

Thanks... I know it's the correct way to write it but my brain can't stop from
finding it weird that way :)

>> +:term:`FILES` variable. For example, the package ``${PN}-dev`` represents files
>> +useful to the development of applications depending on ``${PN}``. The default
>> +list of files for ``${PN}-dev``, also defined in :oe_git:`bitbake.conf
>> +</openembedded-core/tree/meta/conf/bitbake.conf>`, is defined as follows::
>> +
>> +  FILES:${PN}-dev = "${includedir} ${FILES_SOLIBSDEV} ${libdir}/*.la \
>> +                  ${libdir}/*.o ${libdir}/pkgconfig ${datadir}/pkgconfig \
>> +                  ${datadir}/aclocal ${base_libdir}/*.o \
>> +                  ${libdir}/${BPN}/*.la ${base_libdir}/*.la \
>> +                  ${libdir}/cmake ${datadir}/cmake"
>> +
>> +The paths in this list must be *absolute* paths from the point of view of the
>> +root filesystem on the target, and must *not* make references to the variable
>
> I would use the singular here for reference as a path can only make a
> reference to another path and not multiple ones.

+1

>> +:term:`D` or any :term:`WORKDIR` related variable. A correct example would be::
>> +
>> +  ${sysconfdir}/foo.conf
>> +
>> +.. note::
>> +
>> +   The list of files for a package is defined using the override syntax by
>> +   separating :term:`FILES` and the package name by a semi-colon (``:``).
>> +
>> +.. note::
>> +
>> +  To find out which package installs a file, the ``oe-pkgdata-util``
>> +  command-line utility can be used::
>> +
>> +    $ oe-pkgdata-util find-path '/etc/fstab'
>> +    base-files: /etc/fstab
>> +> +  For more information on the ``oe-pkgdata-util`` utility, see the
> section
>> +  :ref:`dev-manual/debugging:Viewing Package Information with
>> +  \`\`oe-pkgdata-util\`\`` of the Yocto Project Development Tasks Manual.
>> +
>
> I would move the second note to after the paragraph in which the "a file
> is only in one package" statement below, but that's personal taste at
> that point :)

Right, I agree.

> Looks good to me.
>
> With the contain/contains typo fixed:
>
> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
>
> Cheers,
> Quentin

Thanks Quentin.

Cheers,
Antonin

--
Antonin Godard, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com