Re: [docs] [PATCH] manuals: fix typos in the context of 'icecc' & clean up whitespaces

["Ulrich Ölmann" <u.oelmann@pengutronix.de>]

Hi Quentin,

On Wed, Sep 14 2022 at 11:46 +0200, "Quentin Schulz" <quentin.schulz@theobroma-systems.com> wrote:
> Hi Ulrich,
>
> On 9/14/22 11:35, Ulrich Ölmann wrote:
>> Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
>> ---
>>   documentation/ref-manual/classes.rst   | 14 +++++++-------
>>   documentation/ref-manual/variables.rst |  4 ++--
>>   2 files changed, 9 insertions(+), 9 deletions(-)
>> diff --git a/documentation/ref-manual/classes.rst
>> b/documentation/ref-manual/classes.rst
>> index 424c505715ff..949de0758d01 100644
>> --- a/documentation/ref-manual/classes.rst
>> +++ b/documentation/ref-manual/classes.rst
>> @@ -580,8 +580,8 @@ Finally, here is an example that sets the root password::
>>   .. note::
>>        From a security perspective, hardcoding a default password is not
>> -   generally a good idea or even legal in some jurisdictions. It is
>> -   recommended that you do not do this if you are building a production
>> +   generally a good idea or even legal in some jurisdictions. It is
>> +   recommended that you do not do this if you are building a production
>>      image.
>>     @@ -792,7 +792,7 @@ The class stages directories with symlinks from
>> ``gcc`` and ``g++`` to
>>   ``icecc``, for both native and cross compilers. Depending on each
>>   configure or compile, the OpenEmbedded build system adds the directories
>>   at the head of the ``PATH`` list and then sets the ``ICECC_CXX`` and
>> -``ICEC_CC`` variables, which are the paths to the ``g++`` and ``gcc``
>> +``ICECC_CC`` variables, which are the paths to the ``g++`` and ``gcc``
>>   compilers, respectively.
>>     For the cross compiler, the class creates a ``tar.gz`` file that
>> @@ -800,8 +800,8 @@ contains the Yocto Project toolchain and sets ``ICECC_VERSION``, which
>>   is the version of the cross-compiler used in the cross-development
>>   toolchain, accordingly.
>>   -The class handles all three different compile stages (i.e native
>> -,cross-kernel and target) and creates the necessary environment
>> +The class handles all three different compile stages (i.e native,
>> +cross-kernel and target) and creates the necessary environment
>>   ``tar.gz`` file to be used by the remote machines. The class also
>>   supports SDK generation.
>>   @@ -811,12 +811,12 @@ using ``which``. If :term:`ICECC_ENV_EXEC` is set
>>   in your ``local.conf`` file, the variable should point to the
>>   ``icecc-create-env`` script provided by the user. If you do not point to
>>   a user-provided script, the build system uses the default script
>> -provided by the recipe ``icecc-create-env-native.bb``.
>> +provided by the recipe ``icecc-create-env_%.bb``.
>>
> % is not a valid character for recipe filename I'm pretty sure. I understand
>   what you want to do but I don't think that's the right way to do it.

to be honest, I already "feared" that this valid argument would come up
for last week's commit [1] in OE-core.  ;-)

[1] https://git.openembedded.org/openembedded-core/commit/?id=7fd33565df5d ("icecc.bbclass: fix typos")

> We could also use the exact filename since the recipe version hasn't changed in
> 11 years so I think it's better to use: icecc-create-env_0.1.bb.
>
> If you're afraid we'll get out-of-date, you could use a link here and someone
> running linkcheck (we really should start doing it...) will be notified of the
> dead link. :oe_git:`icecc-create-env_0.1.bb
> </openembedded-core/tree/meta/recipes-devtools/icecc-create-env/icecc-create-env_0.1.bb>`
> would probably be the link.

That's a good idea: I am going to send a v2 of this patch shortly and a
corresponding fix for OE-core, too.

Thanks for your review!

Best regards
Ulrich


>>   .. note::
>>        This script is a modified version and not the one that comes with
>> -   icecc.
>> +   ``icecream``.
>>     If you do not want the Icecream distributed compile support to apply to
>>   specific recipes or classes, you can ask them to be ignored by Icecream
>> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
>> index df7d4bfbae55..98a981b19b11 100644
>> --- a/documentation/ref-manual/variables.rst
>> +++ b/documentation/ref-manual/variables.rst
>> @@ -2966,8 +2966,8 @@ system and gives an overview of their function and contents.
>>           If you do not point to a script that you provide, the OpenEmbedded
>>         build system uses the default script provided by the
>> -      ``icecc-create-env.bb`` recipe, which is a modified version and not
>> -      the one that comes with ``icecc``.
>> +      ``icecc-create-env_%.bb`` recipe, which is a modified version and not
>
> Ditto.
>
> The rest looks fine, thanks :)
>
> Cheers,
> Quentin
-- 
Pengutronix e.K.                           | Ulrich Ölmann               |
Industrial Linux Solutions                 | http://www.pengutronix.de/  |
Peiner Str. 6-8, 31137 Hildesheim, Germany | Phone: +49-5121-206917-0    |
Amtsgericht Hildesheim, HRA 2686           | Fax:   +49-5121-206917-5555 |