[PATCH] variables.rst: SDKPATHINSTALL correct installation default path

[PATCH] variables.rst: SDKPATHINSTALL correct installation default path

[Johan Bezem]

From: "Bezem, Johan" <jbezem.extern@arri.de>

The SDKPATH variable seems mistakenly identified as the
default path where the SDK will be installed by the generated
installation script, unless option '-d' or a manual input
overrides this default.

From what I understood from the various sources, the intended
variable is SDKPATHINSTALL.

I have tried overriding both SDKPATH and SDKPATHINSTALL
(separately), and only overriding the latter had the intended
effect and was successful.

Signed-off-by: Johan Bezem <jbezem.extern@arri.de>
---
 documentation/ref-manual/variables.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 6f7d6ff01..f292b8dad 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -7611,7 +7611,7 @@ system and gives an overview of their function and contents.
          variable in your distribution configuration file. If you do, the
          configuration will not take effect.
 
-   :term:`SDKPATH`
+   :term:`SDKPATHINSTALL`
       Defines the path offered to the user for installation of the SDK that
       is generated by the OpenEmbedded build system. The path appears as
       the default location for installing the SDK when you run the SDK's
-- 
2.30.2

Re: [docs] [PATCH] variables.rst: SDKPATHINSTALL correct installation default path

[Michael Opdenacker]

Hi Johan

Thanks for pointing this out!

On 2/13/24 at 13:52, Bezem, Johan (extern) wrote:
> From: "Bezem, Johan" <jbezem.extern@arri.de>
>
> The SDKPATH variable seems mistakenly identified as the
> default path where the SDK will be installed by the generated
> installation script, unless option '-d' or a manual input
> overrides this default.
>
>  From what I understood from the various sources, the intended
> variable is SDKPATHINSTALL.
>
> I have tried overriding both SDKPATH and SDKPATHINSTALL
> (separately), and only overriding the latter had the intended
> effect and was successful.
>
> Signed-off-by: Johan Bezem <jbezem.extern@arri.de>
> ---
>   documentation/ref-manual/variables.rst | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
> index 6f7d6ff01..f292b8dad 100644
> --- a/documentation/ref-manual/variables.rst
> +++ b/documentation/ref-manual/variables.rst
> @@ -7611,7 +7611,7 @@ system and gives an overview of their function and contents.
>            variable in your distribution configuration file. If you do, the
>            configuration will not take effect.
>   
> -   :term:`SDKPATH`
> +   :term:`SDKPATHINSTALL`
>         Defines the path offered to the user for installation of the SDK that
>         is generated by the OpenEmbedded build system. The path appears as
>         the default location for installing the SDK when you run the SDK's


I believe we should also keep SDKPATH as it's still used in some recipes 
in Poky. Could you describe it's current usage too?

Another thing is that you should also update 
documentation/overview-manual/concepts.rst which refers to SDKPATH, and 
the description of SDKTARGETSYSROOT too.

You could have caught this by running "make html":
.../yocto-docs/documentation/overview-manual/concepts.rst:1378: WARNING: 
term not in glossary: 'SDKPATH'
.../yocto-docs/documentation/ref-manual/variables.rst:7617: WARNING: 
term not in glossary: 'SDKPATH'

Could you send an update?
Thanks again
Cheers
Michael.

-- 
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com

Re: [docs] [PATCH] variables.rst: SDKPATHINSTALL correct installation default path

[Michael Opdenacker]

Hi Yohan

On 2/14/24 at 10:31, Michael Opdenacker wrote:
> Hi Johan
>
> Thanks for pointing this out!
>
> On 2/13/24 at 13:52, Bezem, Johan (extern) wrote:
>> From: "Bezem, Johan" <jbezem.extern@arri.de>
>>
>> The SDKPATH variable seems mistakenly identified as the
>> default path where the SDK will be installed by the generated
>> installation script, unless option '-d' or a manual input
>> overrides this default.
>>
>>  From what I understood from the various sources, the intended
>> variable is SDKPATHINSTALL.
>>
>> I have tried overriding both SDKPATH and SDKPATHINSTALL
>> (separately), and only overriding the latter had the intended
>> effect and was successful.
>>
>> Signed-off-by: Johan Bezem <jbezem.extern@arri.de>
>> ---
>>   documentation/ref-manual/variables.rst | 2 +-
>>   1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> diff --git a/documentation/ref-manual/variables.rst 
>> b/documentation/ref-manual/variables.rst
>> index 6f7d6ff01..f292b8dad 100644
>> --- a/documentation/ref-manual/variables.rst
>> +++ b/documentation/ref-manual/variables.rst
>> @@ -7611,7 +7611,7 @@ system and gives an overview of their function 
>> and contents.
>>            variable in your distribution configuration file. If you 
>> do, the
>>            configuration will not take effect.
>>   -   :term:`SDKPATH`
>> +   :term:`SDKPATHINSTALL`
>>         Defines the path offered to the user for installation of the 
>> SDK that
>>         is generated by the OpenEmbedded build system. The path 
>> appears as
>>         the default location for installing the SDK when you run the 
>> SDK's
>
>
> I believe we should also keep SDKPATH as it's still used in some 
> recipes in Poky. Could you describe it's current usage too?
>
> Another thing is that you should also update 
> documentation/overview-manual/concepts.rst which refers to SDKPATH, 
> and the description of SDKTARGETSYSROOT too.
>
> You could have caught this by running "make html":
> .../yocto-docs/documentation/overview-manual/concepts.rst:1378: 
> WARNING: term not in glossary: 'SDKPATH'
> .../yocto-docs/documentation/ref-manual/variables.rst:7617: WARNING: 
> term not in glossary: 'SDKPATH'
>
> Could you send an update?


Do you need help doing this? I'll be happy to help if you don't have 
time right now.
Cheers
Michael.

-- 
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com

[PATCH] variables.rst: SDKPATHINSTALL correct installation default path

[Johan Bezem]

From: "Bezem, Johan" <jbezem.extern@arri.de>

The SDKPATH variable seems mistakenly identified as the
default path where the SDK will be installed by the generated
installation script, unless option '-d' or a manual input
overrides this default.

The intended variable is SDKPATHINSTALL. SDKPATH indicates
where the SDK is being composed and built.

The definitions have been added/updated.

Signed-off-by: Johan Bezem <jbezem.extern@arri.de>
---
 documentation/overview-manual/concepts.rst | 2 +-
 documentation/ref-manual/variables.rst     | 6 +++++-
 2 files changed, 6 insertions(+), 2 deletions(-)

diff --git a/documentation/overview-manual/concepts.rst b/documentation/overview-manual/concepts.rst
index d177ca33b..62f2327a7 100644
--- a/documentation/overview-manual/concepts.rst
+++ b/documentation/overview-manual/concepts.rst
@@ -1375,7 +1375,7 @@ This next list, shows the variables associated with a standard SDK:
    Lists packages that make up the target part of the SDK (i.e. the part
    built for the target hardware).
 
--  :term:`SDKPATH`: Defines the
+-  :term:`SDKPATHINSTALL`: Defines the
    default SDK installation path offered by the installation script.
 
 -  :term:`SDK_HOST_MANIFEST`:
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index a0187a6d4..fc348f103 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -7598,6 +7598,10 @@ system and gives an overview of their function and contents.
          configuration will not take effect.
 
    :term:`SDKPATH`
+      Defines the path used to collect the SDK components and build the
+      installer.
+
+   :term:`SDKPATHINSTALL`
       Defines the path offered to the user for installation of the SDK that
       is generated by the OpenEmbedded build system. The path appears as
       the default location for installing the SDK when you run the SDK's
@@ -7607,7 +7611,7 @@ system and gives an overview of their function and contents.
    :term:`SDKTARGETSYSROOT`
       The full path to the sysroot used for cross-compilation within an SDK
       as it will be when installed into the default
-      :term:`SDKPATH`.
+      :term:`SDKPATHINSTALL`.
 
    :term:`SECTION`
       The section in which packages should be categorized. Package
-- 
2.30.2