diff mbox series

[RFC] WIP LICENSE_FLAGS_DETAILS documentation

Message ID 20230524163201.3630288-1-ross.burton@arm.com
State New
Headers show
Series [RFC] WIP LICENSE_FLAGS_DETAILS documentation | expand

Commit Message

Ross Burton May 24, 2023, 4:32 p.m. UTC
From: Ross Burton <ross.burton@arm.com>

---
 documentation/dev-manual/licenses.rst | 7 +++++++
 1 file changed, 7 insertions(+)

Comments

Michael Opdenacker May 26, 2023, 9:18 a.m. UTC | #1
Hi Ross,

On 24.05.23 at 18:32, Ross Burton wrote:
> From: Ross Burton <ross.burton@arm.com>
>
> ---
>   documentation/dev-manual/licenses.rst | 7 +++++++
>   1 file changed, 7 insertions(+)
>
> diff --git a/documentation/dev-manual/licenses.rst b/documentation/dev-manual/licenses.rst
> index 9629dc53293..805b40fd482 100644
> --- a/documentation/dev-manual/licenses.rst
> +++ b/documentation/dev-manual/licenses.rst
> @@ -123,6 +123,13 @@ name and version (after variable expansion)::
>   
>      LICENSE_FLAGS = "license_${PN}_${PV}"
>   
> +It is possible to specify where to find more details for a specific license
> +using flags on the :term:`LICENSE_FLAGS_DETAILS` variable:
> +
> +  LICENSE_FLAGS_DETAILS[my-eula-license] = "https://example.com/eula"
> +
> +If set, this will be displayed to the user if the license hasn't been accepted.
> +
>   In order for a component restricted by a
>   :term:`LICENSE_FLAGS` definition to be enabled and included in an image, it
>   needs to have a matching entry in the global


Thank you for starting this.
I'll get back to it when support for LICENSE_FLAGS_DETAILS is merged.

Cheers
Michael.
Quentin Schulz June 22, 2023, 4:15 p.m. UTC | #2
Hi Michael,

On 5/26/23 11:18, Michael Opdenacker via lists.yoctoproject.org wrote:
> Hi Ross,
> 
> On 24.05.23 at 18:32, Ross Burton wrote:
>> From: Ross Burton <ross.burton@arm.com>
>>
>> ---
>>   documentation/dev-manual/licenses.rst | 7 +++++++
>>   1 file changed, 7 insertions(+)
>>
>> diff --git a/documentation/dev-manual/licenses.rst 
>> b/documentation/dev-manual/licenses.rst
>> index 9629dc53293..805b40fd482 100644
>> --- a/documentation/dev-manual/licenses.rst
>> +++ b/documentation/dev-manual/licenses.rst
>> @@ -123,6 +123,13 @@ name and version (after variable expansion)::
>>      LICENSE_FLAGS = "license_${PN}_${PV}"
>> +It is possible to specify where to find more details for a specific 
>> license
>> +using flags on the :term:`LICENSE_FLAGS_DETAILS` variable:
>> +
>> +  LICENSE_FLAGS_DETAILS[my-eula-license] = 
>> "https://example.com/eula"
>> +
>> +If set, this will be displayed to the user if the license hasn't been 
>> accepted.
>> +
>>   In order for a component restricted by a
>>   :term:`LICENSE_FLAGS` definition to be enabled and included in an 
>> image, it
>>   needs to have a matching entry in the global
> 
> 
> Thank you for starting this.
> I'll get back to it when support for LICENSE_FLAGS_DETAILS is merged.
> 

I believe it's merged now? c.f. 
https://git.openembedded.org/openembedded-core/commit/?id=cb5cdcaf3310e889e80861ccfaf46c1bce624ac1

Maybe we would also benefit from an entry in the variable glossary for 
this one?

Cheers,
Quentin
Quentin Schulz July 31, 2023, 9:08 a.m. UTC | #3
Michael, Ross,

On 6/22/23 18:15, Quentin Schulz via lists.yoctoproject.org wrote:
> Hi Michael,
> 
> On 5/26/23 11:18, Michael Opdenacker via lists.yoctoproject.org wrote:
>> Hi Ross,
>>
>> On 24.05.23 at 18:32, Ross Burton wrote:
>>> From: Ross Burton <ross.burton@arm.com>
>>>
>>> ---
>>>   documentation/dev-manual/licenses.rst | 7 +++++++
>>>   1 file changed, 7 insertions(+)
>>>
>>> diff --git a/documentation/dev-manual/licenses.rst 
>>> b/documentation/dev-manual/licenses.rst
>>> index 9629dc53293..805b40fd482 100644
>>> --- a/documentation/dev-manual/licenses.rst
>>> +++ b/documentation/dev-manual/licenses.rst
>>> @@ -123,6 +123,13 @@ name and version (after variable expansion)::
>>>      LICENSE_FLAGS = "license_${PN}_${PV}"
>>> +It is possible to specify where to find more details for a specific 
>>> license
>>> +using flags on the :term:`LICENSE_FLAGS_DETAILS` variable:
>>> +
>>> +  LICENSE_FLAGS_DETAILS[my-eula-license] = 
>>> "https://example.com/eula"
>>> +
>>> +If set, this will be displayed to the user if the license hasn't 
>>> been accepted.
>>> +
>>>   In order for a component restricted by a
>>>   :term:`LICENSE_FLAGS` definition to be enabled and included in an 
>>> image, it
>>>   needs to have a matching entry in the global
>>
>>
>> Thank you for starting this.
>> I'll get back to it when support for LICENSE_FLAGS_DETAILS is merged.
>>
> 
> I believe it's merged now? c.f. 
> https://git.openembedded.org/openembedded-core/commit/?id=cb5cdcaf3310e889e80861ccfaf46c1bce624ac1
> 
> Maybe we would also benefit from an entry in the variable glossary for 
> this one?
> 

Any feedback to give on this RFC patch now that it's merged?

Cheers,
Quentin
Michael Opdenacker Aug. 3, 2023, 9:05 a.m. UTC | #4
Hi Quentin,

On 31.07.23 at 11:08, Quentin Schulz via lists.yoctoproject.org wrote:
> Michael, Ross,
>
> On 6/22/23 18:15, Quentin Schulz via lists.yoctoproject.org wrote:
>> Hi Michael,
>>
>> On 5/26/23 11:18, Michael Opdenacker via lists.yoctoproject.org wrote:
>>> Hi Ross,
>>>
>>> On 24.05.23 at 18:32, Ross Burton wrote:
>>>> From: Ross Burton <ross.burton@arm.com>
>>>>
>>>> ---
>>>>   documentation/dev-manual/licenses.rst | 7 +++++++
>>>>   1 file changed, 7 insertions(+)
>>>>
>>>> diff --git a/documentation/dev-manual/licenses.rst 
>>>> b/documentation/dev-manual/licenses.rst
>>>> index 9629dc53293..805b40fd482 100644
>>>> --- a/documentation/dev-manual/licenses.rst
>>>> +++ b/documentation/dev-manual/licenses.rst
>>>> @@ -123,6 +123,13 @@ name and version (after variable expansion)::
>>>>      LICENSE_FLAGS = "license_${PN}_${PV}"
>>>> +It is possible to specify where to find more details for a 
>>>> specific license
>>>> +using flags on the :term:`LICENSE_FLAGS_DETAILS` variable:
>>>> +
>>>> +  LICENSE_FLAGS_DETAILS[my-eula-license] = "https://example.com/eula"
>>>> +
>>>> +If set, this will be displayed to the user if the license hasn't 
>>>> been accepted.
>>>> +
>>>>   In order for a component restricted by a
>>>>   :term:`LICENSE_FLAGS` definition to be enabled and included in an 
>>>> image, it
>>>>   needs to have a matching entry in the global
>>>
>>>
>>> Thank you for starting this.
>>> I'll get back to it when support for LICENSE_FLAGS_DETAILS is merged.
>>>
>>
>> I believe it's merged now? c.f. 
>> https://git.openembedded.org/openembedded-core/commit/?id=cb5cdcaf3310e889e80861ccfaf46c1bce624ac1
>>
>> Maybe we would also benefit from an entry in the variable glossary 
>> for this one?
>>
>
> Any feedback to give on this RFC patch now that it's merged?


Thanks for the reminder. I'll take care of it in the next days.
Cheers
Michael.
diff mbox series

Patch

diff --git a/documentation/dev-manual/licenses.rst b/documentation/dev-manual/licenses.rst
index 9629dc53293..805b40fd482 100644
--- a/documentation/dev-manual/licenses.rst
+++ b/documentation/dev-manual/licenses.rst
@@ -123,6 +123,13 @@  name and version (after variable expansion)::
 
    LICENSE_FLAGS = "license_${PN}_${PV}"
 
+It is possible to specify where to find more details for a specific license
+using flags on the :term:`LICENSE_FLAGS_DETAILS` variable:
+
+  LICENSE_FLAGS_DETAILS[my-eula-license] = "https://example.com/eula"
+
+If set, this will be displayed to the user if the license hasn't been accepted.
+
 In order for a component restricted by a
 :term:`LICENSE_FLAGS` definition to be enabled and included in an image, it
 needs to have a matching entry in the global