[PATCH 0/3] new yocto-patches ML + some typo/syntax fixes

[PATCH 0/3] new yocto-patches ML + some typo/syntax fixes

[Quentin Schulz]

Let's mention in the docs there's a new ML where to send patches.

While at it, fix some Python syntax issues and a URL typo.

Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
---
Quentin Schulz (3):
      conf.py: properly escape backslashes for latex_elements
      refer to new yocto-patches mailing list wherever appropriate
      contributor-guide: submit-changes: fix typo in URL

 documentation/conf.py                              | 4 ++--
 documentation/contributor-guide/submit-changes.rst | 4 ++--
 documentation/ref-manual/resources.rst             | 3 +++
 3 files changed, 7 insertions(+), 4 deletions(-)
---
base-commit: 29cee590d59294306600a119048a234f10375603
change-id: 20240328-yocto-patches-ca599f04dce0

Best regards,
-- 
Quentin Schulz <quentin.schulz@theobroma-systems.com>

[PATCH 1/3] conf.py: properly escape backslashes for latex_elements

[Quentin Schulz]

From: Quentin Schulz <quentin.schulz@theobroma-systems.com>

There are some syntax warnings returned by Python:
"""
yocto-docs/documentation/conf.py:162: SyntaxWarning: invalid escape sequence '\P'
  'passoptionstopackages': '\PassOptionsToPackage{bookmarksdepth=5}{hyperref}',
yocto-docs/documentation/conf.py:163: SyntaxWarning: invalid escape sequence '\s'
  'preamble': '\setcounter{tocdepth}{2}',
"""

Backslashes must be doubled in Python string literals to avoid
interpretation as escape sequence, c.f.
https://www.sphinx-doc.org/en/master/latex.html#module-latex.

Cc: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
---
 documentation/conf.py | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/documentation/conf.py b/documentation/conf.py
index a64685ec9..35c5c1453 100644
--- a/documentation/conf.py
+++ b/documentation/conf.py
@@ -159,8 +159,8 @@ html_last_updated_fmt = '%b %d, %Y'
 html_secnumber_suffix = " "
 
 latex_elements = {
-    'passoptionstopackages': '\PassOptionsToPackage{bookmarksdepth=5}{hyperref}',
-    'preamble': '\setcounter{tocdepth}{2}',
+    'passoptionstopackages': '\\PassOptionsToPackage{bookmarksdepth=5}{hyperref}',
+    'preamble': '\\setcounter{tocdepth}{2}',
 }
 
 # Make the EPUB builder prefer PNG to SVG because of issues rendering Inkscape SVG

-- 
2.44.0

[PATCH 2/3] refer to new yocto-patches mailing list wherever appropriate

[Quentin Schulz]

From: Quentin Schulz <quentin.schulz@theobroma-systems.com>

There's a new yocto-patches mailing list available for all layers that
do not have their own mailing list.

c.f. https://lists.yoctoproject.org/g/yocto/topic/105197684

Cc: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
---
 documentation/contributor-guide/submit-changes.rst | 2 +-
 documentation/ref-manual/resources.rst             | 3 +++
 2 files changed, 4 insertions(+), 1 deletion(-)

diff --git a/documentation/contributor-guide/submit-changes.rst b/documentation/contributor-guide/submit-changes.rst
index 95728c25c..b5a6e4240 100644
--- a/documentation/contributor-guide/submit-changes.rst
+++ b/documentation/contributor-guide/submit-changes.rst
@@ -407,7 +407,7 @@ varies by component:
 
 For changes to other layers and tools hosted in the Yocto Project source
 repositories (i.e. :yocto_git:`git.yoctoproject.org <>`), use the
-:yocto_lists:`yocto </g/yocto/>` general mailing list.
+:yocto_lists:`yocto-patches </g/yocto-patches/>` general mailing list.
 
 For changes to other layers hosted in the OpenEmbedded source
 repositories (i.e. :oe_git:`git.openembedded.org <>`), use
diff --git a/documentation/ref-manual/resources.rst b/documentation/ref-manual/resources.rst
index 8e54ac87c..8ffc4ca1e 100644
--- a/documentation/ref-manual/resources.rst
+++ b/documentation/ref-manual/resources.rst
@@ -66,6 +66,9 @@ instructions:
 -  :yocto_lists:`/g/yocto` --- general Yocto Project
    discussion mailing list.
 
+-  :yocto_lists:`/g/yocto-patches` --- patch contibrution mailing list for Yocto
+   Project-related layers which do not have their own mailing list.
+
 -  :oe_lists:`/g/openembedded-core` --- discussion mailing
    list about OpenEmbedded-Core (the core metadata).
 

-- 
2.44.0

[PATCH 3/3] contributor-guide: submit-changes: fix typo in URL

[Quentin Schulz]

From: Quentin Schulz <quentin.schulz@theobroma-systems.com>

lore.kernelorg should be lore.kernel.org as the former doesn't exist.

Cc: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
---
 documentation/contributor-guide/submit-changes.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/documentation/contributor-guide/submit-changes.rst b/documentation/contributor-guide/submit-changes.rst
index b5a6e4240..baba1b659 100644
--- a/documentation/contributor-guide/submit-changes.rst
+++ b/documentation/contributor-guide/submit-changes.rst
@@ -438,7 +438,7 @@ their e-mail clients will default to including your email address in the
 conversation anyway.
 
 Anyway, you'll also be able to access the new messages on mailing list archives,
-either through a web browser, or for the lists archived on https://lore.kernelorg,
+either through a web browser, or for the lists archived on https://lore.kernel.org,
 through an individual newsgroup feed or a git repository.
 
 Sending Patches via Email

-- 
2.44.0

Re: [docs] [PATCH 1/3] conf.py: properly escape backslashes for latex_elements

[Michael Opdenacker]

Hi Quentin

Thanks for the patch!

On 3/28/24 at 16:07, Quentin Schulz wrote:
> From: Quentin Schulz <quentin.schulz@theobroma-systems.com>
>
> There are some syntax warnings returned by Python:
> """
> yocto-docs/documentation/conf.py:162: SyntaxWarning: invalid escape sequence '\P'
>    'passoptionstopackages': '\PassOptionsToPackage{bookmarksdepth=5}{hyperref}',
> yocto-docs/documentation/conf.py:163: SyntaxWarning: invalid escape sequence '\s'
>    'preamble': '\setcounter{tocdepth}{2}',
> """
>
> Backslashes must be doubled in Python string literals to avoid
> interpretation as escape sequence, c.f.
> https://www.sphinx-doc.org/en/master/latex.html#module-latex.

What command(s) were you running to get the error? I didn't see it.
Anyway:
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Merged into "master-next"
Cheers
Michael.

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

Re: [docs] [PATCH 1/3] conf.py: properly escape backslashes for latex_elements

[Quentin Schulz]

Hi Michael,

On 3/29/24 12:12, Michael Opdenacker wrote:
> Hi Quentin
> 
> Thanks for the patch!
> 
> On 3/28/24 at 16:07, Quentin Schulz wrote:
>> From: Quentin Schulz <quentin.schulz@theobroma-systems.com>
>>
>> There are some syntax warnings returned by Python:
>> """
>> yocto-docs/documentation/conf.py:162: SyntaxWarning: invalid escape 
>> sequence '\P'
>>    'passoptionstopackages': 
>> '\PassOptionsToPackage{bookmarksdepth=5}{hyperref}',
>> yocto-docs/documentation/conf.py:163: SyntaxWarning: invalid escape 
>> sequence '\s'
>>    'preamble': '\setcounter{tocdepth}{2}',
>> """
>>
>> Backslashes must be doubled in Python string literals to avoid
>> interpretation as escape sequence, c.f.
>> https://www.sphinx-doc.org/en/master/latex.html#module-latex.
> 
> What command(s) were you running to get the error? I didn't see it.

Normal build instructions, just using Python 3.12.2 on Fedora 39.

https://docs.python.org/3/whatsnew/3.12.html#other-language-changes

"""
A backslash-character pair that is not a valid escape sequence now 
generates a SyntaxWarning, instead of DeprecationWarning. For example, 
re.compile("\d+\.\d+") now emits a SyntaxWarning ("\d" is an invalid 
escape sequence, use raw strings for regular expression: 
re.compile(r"\d+\.\d+")). In a future Python version, SyntaxError will 
eventually be raised, instead of SyntaxWarning. (Contributed by Victor 
Stinner in gh-98401.)
"""

Cheers,
Quentin

Re: [docs] [PATCH 2/3] refer to new yocto-patches mailing list wherever appropriate

[Michael Opdenacker]

Hi Quentin

Thanks for the patch!

On 3/28/24 at 16:07, Quentin Schulz wrote:
> From: Quentin Schulz <quentin.schulz@theobroma-systems.com>
>
> There's a new yocto-patches mailing list available for all layers that
> do not have their own mailing list.
>
> c.f. https://lists.yoctoproject.org/g/yocto/topic/105197684
>
> Cc: Quentin Schulz <foss+yocto@0leil.net>
> Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
> ---
>   documentation/contributor-guide/submit-changes.rst | 2 +-
>   documentation/ref-manual/resources.rst             | 3 +++
>   2 files changed, 4 insertions(+), 1 deletion(-)
>
> diff --git a/documentation/contributor-guide/submit-changes.rst b/documentation/contributor-guide/submit-changes.rst
> index 95728c25c..b5a6e4240 100644
> --- a/documentation/contributor-guide/submit-changes.rst
> +++ b/documentation/contributor-guide/submit-changes.rst
> @@ -407,7 +407,7 @@ varies by component:
>   
>   For changes to other layers and tools hosted in the Yocto Project source
>   repositories (i.e. :yocto_git:`git.yoctoproject.org <>`), use the
> -:yocto_lists:`yocto </g/yocto/>` general mailing list.
> +:yocto_lists:`yocto-patches </g/yocto-patches/>` general mailing list.
>   
>   For changes to other layers hosted in the OpenEmbedded source
>   repositories (i.e. :oe_git:`git.openembedded.org <>`), use
> diff --git a/documentation/ref-manual/resources.rst b/documentation/ref-manual/resources.rst
> index 8e54ac87c..8ffc4ca1e 100644
> --- a/documentation/ref-manual/resources.rst
> +++ b/documentation/ref-manual/resources.rst
> @@ -66,6 +66,9 @@ instructions:
>   -  :yocto_lists:`/g/yocto` --- general Yocto Project
>      discussion mailing list.
>   
> +-  :yocto_lists:`/g/yocto-patches` --- patch contibrution mailing list for Yocto


s/contibrution/contribution/
I fixed this by myself.

Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Merged into master-next.
Thanks again!
Michael.

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

Re: [docs] [PATCH 3/3] contributor-guide: submit-changes: fix typo in URL

[Michael Opdenacker]

On 3/28/24 at 16:07, Quentin Schulz wrote:
> From: Quentin Schulz <quentin.schulz@theobroma-systems.com>
>
> lore.kernelorg should be lore.kernel.org as the former doesn't exist.
>
> Cc: Quentin Schulz <foss+yocto@0leil.net>
> Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
> ---
>   documentation/contributor-guide/submit-changes.rst | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/documentation/contributor-guide/submit-changes.rst b/documentation/contributor-guide/submit-changes.rst
> index b5a6e4240..baba1b659 100644
> --- a/documentation/contributor-guide/submit-changes.rst
> +++ b/documentation/contributor-guide/submit-changes.rst
> @@ -438,7 +438,7 @@ their e-mail clients will default to including your email address in the
>   conversation anyway.
>   
>   Anyway, you'll also be able to access the new messages on mailing list archives,
> -either through a web browser, or for the lists archived on https://lore.kernelorg,
> +either through a web browser, or for the lists archived on https://lore.kernel.org,
>   through an individual newsgroup feed or a git repository.


Too late, already fixed in 
https://git.yoctoproject.org/yocto-docs/commit/?id=5962a09a120681c1328e05335c2f14fad06c63ce
Thanks anyway!
Cheers
Michael.

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

Re: [docs] [PATCH 3/3] contributor-guide: submit-changes: fix typo in URL

[Quentin Schulz]

Hi Michael,

On 3/29/24 12:21, Michael Opdenacker wrote:
> 
> On 3/28/24 at 16:07, Quentin Schulz wrote:
>> From: Quentin Schulz <quentin.schulz@theobroma-systems.com>
>>
>> lore.kernelorg should be lore.kernel.org as the former doesn't exist.
>>
>> Cc: Quentin Schulz <foss+yocto@0leil.net>
>> Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
>> ---
>>   documentation/contributor-guide/submit-changes.rst | 2 +-
>>   1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> diff --git a/documentation/contributor-guide/submit-changes.rst 
>> b/documentation/contributor-guide/submit-changes.rst
>> index b5a6e4240..baba1b659 100644
>> --- a/documentation/contributor-guide/submit-changes.rst
>> +++ b/documentation/contributor-guide/submit-changes.rst
>> @@ -438,7 +438,7 @@ their e-mail clients will default to including 
>> your email address in the
>>   conversation anyway.
>>   Anyway, you'll also be able to access the new messages on mailing 
>> list archives,
>> -either through a web browser, or for the lists archived on 
>> https://lore.kernelorg/,
>> +either through a web browser, or for the lists archived on 
>> https://lore.kernel.org/,
>>   through an individual newsgroup feed or a git repository.
> 
> 
> Too late, already fixed in 
> https://git.yoctoproject.org/yocto-docs/commit/?id=5962a09a120681c1328e05335c2f14fad06c63ce

Mmmm, forgot to run git pull before starting to write the patches :/

Thanks for the catches and sorry for the noise.

Cheers,
Quentin