[libcamera-devel,PATCH/RFC,08/11] licenses: Add SPDX headers to the website builder and theme

Message ID 20200213153635.27953-9-laurent.pinchart@ideasonboard.com
State Accepted
Headers show
Series
  • Improve license information
Related show

Commit Message

Laurent Pinchart Feb. 13, 2020, 3:36 p.m. UTC
Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
---
 Documentation/conf.py                    | 1 +
 Documentation/theme/footer.html          | 3 +++
 Documentation/theme/layout.html          | 3 +++
 Documentation/theme/search.html          | 3 +++
 Documentation/theme/static/css/theme.css | 2 ++
 Documentation/theme/theme.conf           | 2 ++
 6 files changed, 14 insertions(+)

Comments

Kieran Bingham Feb. 13, 2020, 3:49 p.m. UTC | #1
Hi Laurent,

On 13/02/2020 15:36, Laurent Pinchart wrote:
> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>


All of these detail the SPDX of the files themselves.

Do we specify anywhere in the generated documentation itself what the
licence terms are for the content?

--
Kieran


> ---
>  Documentation/conf.py                    | 1 +
>  Documentation/theme/footer.html          | 3 +++
>  Documentation/theme/layout.html          | 3 +++
>  Documentation/theme/search.html          | 3 +++
>  Documentation/theme/static/css/theme.css | 2 ++
>  Documentation/theme/theme.conf           | 2 ++
>  6 files changed, 14 insertions(+)
> 
> diff --git a/Documentation/conf.py b/Documentation/conf.py
> index bffd1d8f1e5d..78602c85e33f 100644
> --- a/Documentation/conf.py
> +++ b/Documentation/conf.py
> @@ -1,3 +1,4 @@
> +# SPDX-License-Identifier: CC-BY-SA-4.0
>  # -*- coding: utf-8 -*-
>  #
>  # Configuration file for the Sphinx documentation builder.
> diff --git a/Documentation/theme/footer.html b/Documentation/theme/footer.html
> index e63e9fb31099..12939e8b7c12 100644
> --- a/Documentation/theme/footer.html
> +++ b/Documentation/theme/footer.html
> @@ -1,3 +1,6 @@
> +{#
> +SPDX-License-Identifier: CC-BY-SA-4.0
> +#}
>  <footer>
>    <div id="signature">
>      {%- if show_copyright %}
> diff --git a/Documentation/theme/layout.html b/Documentation/theme/layout.html
> index 139c39c7cc38..fcc6d221870c 100644
> --- a/Documentation/theme/layout.html
> +++ b/Documentation/theme/layout.html
> @@ -1,3 +1,6 @@
> +{#
> +SPDX-License-Identifier: CC-BY-SA-4.0
> +#}
>  {# TEMPLATE VAR SETTINGS #}
>  {%- set url_root = pathto('', 1) %}
>  {%- if url_root == '#' %}{% set url_root = '' %}{% endif %}
> diff --git a/Documentation/theme/search.html b/Documentation/theme/search.html
> index 14d59395df10..00c2af93a1b3 100644
> --- a/Documentation/theme/search.html
> +++ b/Documentation/theme/search.html
> @@ -1,3 +1,6 @@
> +{#
> +SPDX-License-Identifier: CC-BY-SA-4.0
> +#}
>  {#
>      basic/search.html
>      ~~~~~~~~~~~~~~~~~
> diff --git a/Documentation/theme/static/css/theme.css b/Documentation/theme/static/css/theme.css
> index a4934edeeb8f..d4274ea6f65d 100644
> --- a/Documentation/theme/static/css/theme.css
> +++ b/Documentation/theme/static/css/theme.css
> @@ -1,3 +1,5 @@
> +/* SPDX-License-Identifier: CC-BY-SA-4.0 */
> +
>  html {
>  	background-image: linear-gradient(to bottom right, #4895e1, #56c3ae);
>  	background-size: cover;
> diff --git a/Documentation/theme/theme.conf b/Documentation/theme/theme.conf
> index ba25a19211c7..f2ab39c33c5b 100644
> --- a/Documentation/theme/theme.conf
> +++ b/Documentation/theme/theme.conf
> @@ -1,3 +1,5 @@
> +# SPDX-License-Identifier: CC-BY-SA-4.0
> +
>  [theme]
>  inherit = basic
>  stylesheet = css/theme.css
>
Laurent Pinchart Feb. 13, 2020, 4:26 p.m. UTC | #2
Hi Kieran,

On Thu, Feb 13, 2020 at 03:49:17PM +0000, Kieran Bingham wrote:
> On 13/02/2020 15:36, Laurent Pinchart wrote:
> > Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
> 
> All of these detail the SPDX of the files themselves.
> 
> Do we specify anywhere in the generated documentation itself what the
> licence terms are for the content?

I don't think we do. It's a good point. Should we add that to the footer
? Possibly in a separate patch ?

> > ---
> >  Documentation/conf.py                    | 1 +
> >  Documentation/theme/footer.html          | 3 +++
> >  Documentation/theme/layout.html          | 3 +++
> >  Documentation/theme/search.html          | 3 +++
> >  Documentation/theme/static/css/theme.css | 2 ++
> >  Documentation/theme/theme.conf           | 2 ++
> >  6 files changed, 14 insertions(+)
> > 
> > diff --git a/Documentation/conf.py b/Documentation/conf.py
> > index bffd1d8f1e5d..78602c85e33f 100644
> > --- a/Documentation/conf.py
> > +++ b/Documentation/conf.py
> > @@ -1,3 +1,4 @@
> > +# SPDX-License-Identifier: CC-BY-SA-4.0
> >  # -*- coding: utf-8 -*-
> >  #
> >  # Configuration file for the Sphinx documentation builder.
> > diff --git a/Documentation/theme/footer.html b/Documentation/theme/footer.html
> > index e63e9fb31099..12939e8b7c12 100644
> > --- a/Documentation/theme/footer.html
> > +++ b/Documentation/theme/footer.html
> > @@ -1,3 +1,6 @@
> > +{#
> > +SPDX-License-Identifier: CC-BY-SA-4.0
> > +#}
> >  <footer>
> >    <div id="signature">
> >      {%- if show_copyright %}
> > diff --git a/Documentation/theme/layout.html b/Documentation/theme/layout.html
> > index 139c39c7cc38..fcc6d221870c 100644
> > --- a/Documentation/theme/layout.html
> > +++ b/Documentation/theme/layout.html
> > @@ -1,3 +1,6 @@
> > +{#
> > +SPDX-License-Identifier: CC-BY-SA-4.0
> > +#}
> >  {# TEMPLATE VAR SETTINGS #}
> >  {%- set url_root = pathto('', 1) %}
> >  {%- if url_root == '#' %}{% set url_root = '' %}{% endif %}
> > diff --git a/Documentation/theme/search.html b/Documentation/theme/search.html
> > index 14d59395df10..00c2af93a1b3 100644
> > --- a/Documentation/theme/search.html
> > +++ b/Documentation/theme/search.html
> > @@ -1,3 +1,6 @@
> > +{#
> > +SPDX-License-Identifier: CC-BY-SA-4.0
> > +#}
> >  {#
> >      basic/search.html
> >      ~~~~~~~~~~~~~~~~~
> > diff --git a/Documentation/theme/static/css/theme.css b/Documentation/theme/static/css/theme.css
> > index a4934edeeb8f..d4274ea6f65d 100644
> > --- a/Documentation/theme/static/css/theme.css
> > +++ b/Documentation/theme/static/css/theme.css
> > @@ -1,3 +1,5 @@
> > +/* SPDX-License-Identifier: CC-BY-SA-4.0 */
> > +
> >  html {
> >  	background-image: linear-gradient(to bottom right, #4895e1, #56c3ae);
> >  	background-size: cover;
> > diff --git a/Documentation/theme/theme.conf b/Documentation/theme/theme.conf
> > index ba25a19211c7..f2ab39c33c5b 100644
> > --- a/Documentation/theme/theme.conf
> > +++ b/Documentation/theme/theme.conf
> > @@ -1,3 +1,5 @@
> > +# SPDX-License-Identifier: CC-BY-SA-4.0
> > +
> >  [theme]
> >  inherit = basic
> >  stylesheet = css/theme.css
Kieran Bingham Feb. 13, 2020, 4:37 p.m. UTC | #3
On 13/02/2020 16:26, Laurent Pinchart wrote:
> Hi Kieran,
> 
> On Thu, Feb 13, 2020 at 03:49:17PM +0000, Kieran Bingham wrote:
>> On 13/02/2020 15:36, Laurent Pinchart wrote:
>>> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
>>
>> All of these detail the SPDX of the files themselves.
>>
>> Do we specify anywhere in the generated documentation itself what the
>> licence terms are for the content?
> 
> I don't think we do. It's a good point. Should we add that to the footer
> ? Possibly in a separate patch ?

Adding to the footer seems appropriate to me.

And I'm fine with a separate patch.

Which leaves this patch with a:

Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>

> 
>>> ---
>>>  Documentation/conf.py                    | 1 +
>>>  Documentation/theme/footer.html          | 3 +++
>>>  Documentation/theme/layout.html          | 3 +++
>>>  Documentation/theme/search.html          | 3 +++
>>>  Documentation/theme/static/css/theme.css | 2 ++
>>>  Documentation/theme/theme.conf           | 2 ++
>>>  6 files changed, 14 insertions(+)
>>>
>>> diff --git a/Documentation/conf.py b/Documentation/conf.py
>>> index bffd1d8f1e5d..78602c85e33f 100644
>>> --- a/Documentation/conf.py
>>> +++ b/Documentation/conf.py
>>> @@ -1,3 +1,4 @@
>>> +# SPDX-License-Identifier: CC-BY-SA-4.0
>>>  # -*- coding: utf-8 -*-
>>>  #
>>>  # Configuration file for the Sphinx documentation builder.
>>> diff --git a/Documentation/theme/footer.html b/Documentation/theme/footer.html
>>> index e63e9fb31099..12939e8b7c12 100644
>>> --- a/Documentation/theme/footer.html
>>> +++ b/Documentation/theme/footer.html
>>> @@ -1,3 +1,6 @@
>>> +{#
>>> +SPDX-License-Identifier: CC-BY-SA-4.0
>>> +#}
>>>  <footer>
>>>    <div id="signature">
>>>      {%- if show_copyright %}
>>> diff --git a/Documentation/theme/layout.html b/Documentation/theme/layout.html
>>> index 139c39c7cc38..fcc6d221870c 100644
>>> --- a/Documentation/theme/layout.html
>>> +++ b/Documentation/theme/layout.html
>>> @@ -1,3 +1,6 @@
>>> +{#
>>> +SPDX-License-Identifier: CC-BY-SA-4.0
>>> +#}
>>>  {# TEMPLATE VAR SETTINGS #}
>>>  {%- set url_root = pathto('', 1) %}
>>>  {%- if url_root == '#' %}{% set url_root = '' %}{% endif %}
>>> diff --git a/Documentation/theme/search.html b/Documentation/theme/search.html
>>> index 14d59395df10..00c2af93a1b3 100644
>>> --- a/Documentation/theme/search.html
>>> +++ b/Documentation/theme/search.html
>>> @@ -1,3 +1,6 @@
>>> +{#
>>> +SPDX-License-Identifier: CC-BY-SA-4.0
>>> +#}
>>>  {#
>>>      basic/search.html
>>>      ~~~~~~~~~~~~~~~~~
>>> diff --git a/Documentation/theme/static/css/theme.css b/Documentation/theme/static/css/theme.css
>>> index a4934edeeb8f..d4274ea6f65d 100644
>>> --- a/Documentation/theme/static/css/theme.css
>>> +++ b/Documentation/theme/static/css/theme.css
>>> @@ -1,3 +1,5 @@
>>> +/* SPDX-License-Identifier: CC-BY-SA-4.0 */
>>> +
>>>  html {
>>>  	background-image: linear-gradient(to bottom right, #4895e1, #56c3ae);
>>>  	background-size: cover;
>>> diff --git a/Documentation/theme/theme.conf b/Documentation/theme/theme.conf
>>> index ba25a19211c7..f2ab39c33c5b 100644
>>> --- a/Documentation/theme/theme.conf
>>> +++ b/Documentation/theme/theme.conf
>>> @@ -1,3 +1,5 @@
>>> +# SPDX-License-Identifier: CC-BY-SA-4.0
>>> +
>>>  [theme]
>>>  inherit = basic
>>>  stylesheet = css/theme.css
>
Laurent Pinchart Feb. 13, 2020, 4:41 p.m. UTC | #4
Hi Kieran,

On Thu, Feb 13, 2020 at 04:37:40PM +0000, Kieran Bingham wrote:
> On 13/02/2020 16:26, Laurent Pinchart wrote:
> > On Thu, Feb 13, 2020 at 03:49:17PM +0000, Kieran Bingham wrote:
> >> On 13/02/2020 15:36, Laurent Pinchart wrote:
> >>> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
> >>
> >> All of these detail the SPDX of the files themselves.
> >>
> >> Do we specify anywhere in the generated documentation itself what the
> >> licence terms are for the content?
> > 
> > I don't think we do. It's a good point. Should we add that to the footer
> > ? Possibly in a separate patch ?
> 
> Adding to the footer seems appropriate to me.

Actually I think the footer should link to a separate page, where we can
explain copyright in details, otherwise the footer would grow too large.

> And I'm fine with a separate patch.
> 
> Which leaves this patch with a:
> 
> Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
> 
> >>> ---
> >>>  Documentation/conf.py                    | 1 +
> >>>  Documentation/theme/footer.html          | 3 +++
> >>>  Documentation/theme/layout.html          | 3 +++
> >>>  Documentation/theme/search.html          | 3 +++
> >>>  Documentation/theme/static/css/theme.css | 2 ++
> >>>  Documentation/theme/theme.conf           | 2 ++
> >>>  6 files changed, 14 insertions(+)
> >>>
> >>> diff --git a/Documentation/conf.py b/Documentation/conf.py
> >>> index bffd1d8f1e5d..78602c85e33f 100644
> >>> --- a/Documentation/conf.py
> >>> +++ b/Documentation/conf.py
> >>> @@ -1,3 +1,4 @@
> >>> +# SPDX-License-Identifier: CC-BY-SA-4.0
> >>>  # -*- coding: utf-8 -*-
> >>>  #
> >>>  # Configuration file for the Sphinx documentation builder.
> >>> diff --git a/Documentation/theme/footer.html b/Documentation/theme/footer.html
> >>> index e63e9fb31099..12939e8b7c12 100644
> >>> --- a/Documentation/theme/footer.html
> >>> +++ b/Documentation/theme/footer.html
> >>> @@ -1,3 +1,6 @@
> >>> +{#
> >>> +SPDX-License-Identifier: CC-BY-SA-4.0
> >>> +#}
> >>>  <footer>
> >>>    <div id="signature">
> >>>      {%- if show_copyright %}
> >>> diff --git a/Documentation/theme/layout.html b/Documentation/theme/layout.html
> >>> index 139c39c7cc38..fcc6d221870c 100644
> >>> --- a/Documentation/theme/layout.html
> >>> +++ b/Documentation/theme/layout.html
> >>> @@ -1,3 +1,6 @@
> >>> +{#
> >>> +SPDX-License-Identifier: CC-BY-SA-4.0
> >>> +#}
> >>>  {# TEMPLATE VAR SETTINGS #}
> >>>  {%- set url_root = pathto('', 1) %}
> >>>  {%- if url_root == '#' %}{% set url_root = '' %}{% endif %}
> >>> diff --git a/Documentation/theme/search.html b/Documentation/theme/search.html
> >>> index 14d59395df10..00c2af93a1b3 100644
> >>> --- a/Documentation/theme/search.html
> >>> +++ b/Documentation/theme/search.html
> >>> @@ -1,3 +1,6 @@
> >>> +{#
> >>> +SPDX-License-Identifier: CC-BY-SA-4.0
> >>> +#}
> >>>  {#
> >>>      basic/search.html
> >>>      ~~~~~~~~~~~~~~~~~
> >>> diff --git a/Documentation/theme/static/css/theme.css b/Documentation/theme/static/css/theme.css
> >>> index a4934edeeb8f..d4274ea6f65d 100644
> >>> --- a/Documentation/theme/static/css/theme.css
> >>> +++ b/Documentation/theme/static/css/theme.css
> >>> @@ -1,3 +1,5 @@
> >>> +/* SPDX-License-Identifier: CC-BY-SA-4.0 */
> >>> +
> >>>  html {
> >>>  	background-image: linear-gradient(to bottom right, #4895e1, #56c3ae);
> >>>  	background-size: cover;
> >>> diff --git a/Documentation/theme/theme.conf b/Documentation/theme/theme.conf
> >>> index ba25a19211c7..f2ab39c33c5b 100644
> >>> --- a/Documentation/theme/theme.conf
> >>> +++ b/Documentation/theme/theme.conf
> >>> @@ -1,3 +1,5 @@
> >>> +# SPDX-License-Identifier: CC-BY-SA-4.0
> >>> +
> >>>  [theme]
> >>>  inherit = basic
> >>>  stylesheet = css/theme.css

Patch

diff --git a/Documentation/conf.py b/Documentation/conf.py
index bffd1d8f1e5d..78602c85e33f 100644
--- a/Documentation/conf.py
+++ b/Documentation/conf.py
@@ -1,3 +1,4 @@ 
+# SPDX-License-Identifier: CC-BY-SA-4.0
 # -*- coding: utf-8 -*-
 #
 # Configuration file for the Sphinx documentation builder.
diff --git a/Documentation/theme/footer.html b/Documentation/theme/footer.html
index e63e9fb31099..12939e8b7c12 100644
--- a/Documentation/theme/footer.html
+++ b/Documentation/theme/footer.html
@@ -1,3 +1,6 @@ 
+{#
+SPDX-License-Identifier: CC-BY-SA-4.0
+#}
 <footer>
   <div id="signature">
     {%- if show_copyright %}
diff --git a/Documentation/theme/layout.html b/Documentation/theme/layout.html
index 139c39c7cc38..fcc6d221870c 100644
--- a/Documentation/theme/layout.html
+++ b/Documentation/theme/layout.html
@@ -1,3 +1,6 @@ 
+{#
+SPDX-License-Identifier: CC-BY-SA-4.0
+#}
 {# TEMPLATE VAR SETTINGS #}
 {%- set url_root = pathto('', 1) %}
 {%- if url_root == '#' %}{% set url_root = '' %}{% endif %}
diff --git a/Documentation/theme/search.html b/Documentation/theme/search.html
index 14d59395df10..00c2af93a1b3 100644
--- a/Documentation/theme/search.html
+++ b/Documentation/theme/search.html
@@ -1,3 +1,6 @@ 
+{#
+SPDX-License-Identifier: CC-BY-SA-4.0
+#}
 {#
     basic/search.html
     ~~~~~~~~~~~~~~~~~
diff --git a/Documentation/theme/static/css/theme.css b/Documentation/theme/static/css/theme.css
index a4934edeeb8f..d4274ea6f65d 100644
--- a/Documentation/theme/static/css/theme.css
+++ b/Documentation/theme/static/css/theme.css
@@ -1,3 +1,5 @@ 
+/* SPDX-License-Identifier: CC-BY-SA-4.0 */
+
 html {
 	background-image: linear-gradient(to bottom right, #4895e1, #56c3ae);
 	background-size: cover;
diff --git a/Documentation/theme/theme.conf b/Documentation/theme/theme.conf
index ba25a19211c7..f2ab39c33c5b 100644
--- a/Documentation/theme/theme.conf
+++ b/Documentation/theme/theme.conf
@@ -1,3 +1,5 @@ 
+# SPDX-License-Identifier: CC-BY-SA-4.0
+
 [theme]
 inherit = basic
 stylesheet = css/theme.css