[Buildroot] [PATCH 1/6] utils/readme.txt: expand check-package description

[Buildroot] [PATCH 1/6] utils/readme.txt: expand check-package description

[Marcus Hoffmann via buildroot]

check-package does a lot more by now than checking .mk and
Config.in files. Add this to the description.

Signed-off-by: Marcus Hoffmann <buildroot@bubu1.eu>
---
 utils/readme.txt | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/utils/readme.txt b/utils/readme.txt
index 3e8833c4ea..d5cda70bfc 100644
--- a/utils/readme.txt
+++ b/utils/readme.txt
@@ -12,8 +12,11 @@ brmake
     nothing.
 
 check-package
-    a script that checks the coding style of a package's Config.in and
-    .mk files, and also tests them for various types of typoes.
+    a script that checks the coding style across the buildroot tree. It
+    checks package's Config.in and .mk files, runs shellcheck for all shell
+    scripts, flake8 for python files, checks for typoes, etc.
+    It checks the .checkpackageignore file if errors should be ignored and
+    errors if there's a file listed that doesn't produce an error.
 
 genrandconfig
     a script that generates a random configuration, used by the autobuilders
-- 
2.43.0

_______________________________________________
buildroot mailing list
buildroot@buildroot.org
https://lists.buildroot.org/mailman/listinfo/buildroot

[Buildroot] [PATCH 2/6] utils/readme.txt: document docker-run script

[Marcus Hoffmann via buildroot]

Signed-off-by: Marcus Hoffmann <buildroot@bubu1.eu>
---
 utils/readme.txt | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/utils/readme.txt b/utils/readme.txt
index d5cda70bfc..2cb6b0af9b 100644
--- a/utils/readme.txt
+++ b/utils/readme.txt
@@ -18,6 +18,10 @@ check-package
     It checks the .checkpackageignore file if errors should be ignored and
     errors if there's a file listed that doesn't produce an error.
 
+docker-run
+    a script that runs a command (like make check-package) inside the buildroot
+    ci docker container.
+
 genrandconfig
     a script that generates a random configuration, used by the autobuilders
     (http://autobuild.buildroot.org). It selects a random toolchain from
-- 
2.43.0

_______________________________________________
buildroot mailing list
buildroot@buildroot.org
https://lists.buildroot.org/mailman/listinfo/buildroot

[Buildroot] [PATCH 3/6] docs/website/support.html: document how to join irc channel from matrix

[Marcus Hoffmann via buildroot]

Signed-off-by: Marcus Hoffmann <buildroot@bubu1.eu>
---
 docs/website/support.html | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/docs/website/support.html b/docs/website/support.html
index 9be816f836..13d63b13a9 100644
--- a/docs/website/support.html
+++ b/docs/website/support.html
@@ -21,7 +21,9 @@
 		<div class="col-sm-11">
 		  <p>The Buildroot IRC channel is <a href="irc://irc.oftc.net/#buildroot">
 		      #buildroot</a>, hosted on OFTC. If you do not have an IRC client, you can
-		    use the <a href="https://www.oftc.net/WebChat/">OFTC web interface</a>.
+		    use the <a href="https://www.oftc.net/WebChat/">OFTC web interface</a>. The
+		    channel is also bridged to matrix as <a href="https://matrix.to/#/#_oftc_#buildroot:matrix.org">
+		      #_oftc_#buildroot:matrix.org</a>.
 		    When asking for help on IRC, share relevant logs or pieces of code using a code
 		    sharing website.</p>
 
-- 
2.43.0

_______________________________________________
buildroot mailing list
buildroot@buildroot.org
https://lists.buildroot.org/mailman/listinfo/buildroot

[Buildroot] [PATCH 4/6] docs/website/support.html: document irc channel permission changes

[Marcus Hoffmann via buildroot]

The #buildroot IRC channel recently changed from only allowing
registered users to join to allowing anyone to join but only allowing
registered users to talk in the channel. This still avoids the spam
problem on IRC while allowing an exception for users bridged from
matrix.org. These already have a username registered on the matrix side
and thus similar properties as a registered IRC user/nick.

The commands to set these options were:

* Set +q on all unregistered nicks: ~/mode #buildroot +q $~a~ this lets
  people join but they can't talk
* Set exempt on matrix hosts: ~/mode #buildroot +e $x:matrix.org~

Signed-off-by: Marcus Hoffmann <buildroot@bubu1.eu>
---
 docs/website/support.html | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/docs/website/support.html b/docs/website/support.html
index 13d63b13a9..28873c6d76 100644
--- a/docs/website/support.html
+++ b/docs/website/support.html
@@ -27,8 +27,8 @@
 		    When asking for help on IRC, share relevant logs or pieces of code using a code
 		    sharing website.</p>
 
-		  <p>Note that due to excessive spamming on IRC, the channel can only be
-		    joined if you are a registered user with
+		  <p>Note that due to excessive spamming on IRC, you can only talk in the
+		    channel if you are a registered user with
 		    <a href="https://www.oftc.net/Services/">OFTC NickServ</a>
 		    service. Follow the instructions to register as a user with a password,
 		    and then join the <code>#buildroot</code> channel.</p>
-- 
2.43.0

_______________________________________________
buildroot mailing list
buildroot@buildroot.org
https://lists.buildroot.org/mailman/listinfo/buildroot

[Buildroot] [PATCH 5/6] docs/manual/contribute.adoc: link to git-send-email.io

[Marcus Hoffmann via buildroot]

https://git-send-email.io/ is a page maintained by sourcehut which
explains how to setup git send-email on many OS's for many popular email
providers.

Signed-off-by: Marcus Hoffmann <buildroot@bubu1.eu>
---
 docs/manual/contribute.adoc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/manual/contribute.adoc b/docs/manual/contribute.adoc
index 2b90d13b41..684e9f4809 100644
--- a/docs/manual/contribute.adoc
+++ b/docs/manual/contribute.adoc
@@ -369,7 +369,7 @@ $ git send-email origin/master
 ---------------------
 
 Note that +git+ should be configured to use your mail account.
-To configure +git+, see +man git-send-email+ or google it.
+To configure +git+, see +man git-send-email+ or https://git-send-email.io/.
 
 If you do not use +git send-email+, make sure posted *patches are not
 line-wrapped*, otherwise they cannot easily be applied. In such a case,
-- 
2.43.0

_______________________________________________
buildroot mailing list
buildroot@buildroot.org
https://lists.buildroot.org/mailman/listinfo/buildroot

[Buildroot] [PATCH 6/6] docs/manual/contribute.adoc: mention sr.ht as an alternative for sending patches

[Marcus Hoffmann via buildroot]

Signed-off-by: Marcus Hoffmann <buildroot@bubu1.eu>
---
 docs/manual/contribute.adoc | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/docs/manual/contribute.adoc b/docs/manual/contribute.adoc
index 684e9f4809..7d0611be28 100644
--- a/docs/manual/contribute.adoc
+++ b/docs/manual/contribute.adoc
@@ -375,6 +375,14 @@ If you do not use +git send-email+, make sure posted *patches are not
 line-wrapped*, otherwise they cannot easily be applied. In such a case,
 fix your e-mail client, or better yet, learn to use +git send-email+.
 
+https://sr.ht also has a light-weight UI for
+https://man.sr.ht/git.sr.ht/#sending-patches-upstream[preparing patchseries]
+and can also send out the patches for you. There are a few drawbacks to
+this, as you cannot edit your patches' status in Patchwork and you
+currently can't edit your display name with which the match emails are
+sent out but it is an option if you cannot get git send-email to work
+with your mail provider (i.e. O365).
+
 ==== Cover letter
 
 If you want to present the whole patch set in a separate mail, add
-- 
2.43.0

_______________________________________________
buildroot mailing list
buildroot@buildroot.org
https://lists.buildroot.org/mailman/listinfo/buildroot

Re: [Buildroot] [PATCH 1/6] utils/readme.txt: expand check-package description

[Yann E. MORIN]

Marcus, All,

On 2024-02-06 11:52 +0100, Marcus Hoffmann via buildroot spake thusly:
> check-package does a lot more by now than checking .mk and
> Config.in files. Add this to the description.
> 
> Signed-off-by: Marcus Hoffmann <buildroot@bubu1.eu>

Applied to master, thanks.

Regards,
Yann E. MORIN.

> ---
>  utils/readme.txt | 7 +++++--
>  1 file changed, 5 insertions(+), 2 deletions(-)
> 
> diff --git a/utils/readme.txt b/utils/readme.txt
> index 3e8833c4ea..d5cda70bfc 100644
> --- a/utils/readme.txt
> +++ b/utils/readme.txt
> @@ -12,8 +12,11 @@ brmake
>      nothing.
>  
>  check-package
> -    a script that checks the coding style of a package's Config.in and
> -    .mk files, and also tests them for various types of typoes.
> +    a script that checks the coding style across the buildroot tree. It
> +    checks package's Config.in and .mk files, runs shellcheck for all shell
> +    scripts, flake8 for python files, checks for typoes, etc.
> +    It checks the .checkpackageignore file if errors should be ignored and
> +    errors if there's a file listed that doesn't produce an error.
>  
>  genrandconfig
>      a script that generates a random configuration, used by the autobuilders
> -- 
> 2.43.0
> 
> _______________________________________________
> buildroot mailing list
> buildroot@buildroot.org
> https://lists.buildroot.org/mailman/listinfo/buildroot

-- 
.-----------------.--------------------.------------------.--------------------.
|  Yann E. MORIN  | Real-Time Embedded | /"\ ASCII RIBBON | Erics' conspiracy: |
| +33 662 376 056 | Software  Designer | \ / CAMPAIGN     |  ___               |
| +33 561 099 427 `------------.-------:  X  AGAINST      |  \e/  There is no  |
| http://ymorin.is-a-geek.org/ | _/*\_ | / \ HTML MAIL    |   v   conspiracy.  |
'------------------------------^-------^------------------^--------------------'
_______________________________________________
buildroot mailing list
buildroot@buildroot.org
https://lists.buildroot.org/mailman/listinfo/buildroot

Re: [Buildroot] [PATCH 2/6] utils/readme.txt: document docker-run script

[Yann E. MORIN]

Marcus, All,

On 2024-02-06 11:52 +0100, Marcus Hoffmann via buildroot spake thusly:
> Signed-off-by: Marcus Hoffmann <buildroot@bubu1.eu>
> ---
>  utils/readme.txt | 4 ++++
>  1 file changed, 4 insertions(+)
> 
> diff --git a/utils/readme.txt b/utils/readme.txt
> index d5cda70bfc..2cb6b0af9b 100644
> --- a/utils/readme.txt
> +++ b/utils/readme.txt
> @@ -18,6 +18,10 @@ check-package
>      It checks the .checkpackageignore file if errors should be ignored and
>      errors if there's a file listed that doesn't produce an error.
>  
> +docker-run
> +    a script that runs a command (like make check-package) inside the buildroot
> +    ci docker container.

I've slightly extended that to state that an interactive shell is
spawned if not command is specified.

Applied to master, thanks.

Regards,
Yann E. MORIN.

>  genrandconfig
>      a script that generates a random configuration, used by the autobuilders
>      (http://autobuild.buildroot.org). It selects a random toolchain from
> -- 
> 2.43.0
> 
> _______________________________________________
> buildroot mailing list
> buildroot@buildroot.org
> https://lists.buildroot.org/mailman/listinfo/buildroot

-- 
.-----------------.--------------------.------------------.--------------------.
|  Yann E. MORIN  | Real-Time Embedded | /"\ ASCII RIBBON | Erics' conspiracy: |
| +33 662 376 056 | Software  Designer | \ / CAMPAIGN     |  ___               |
| +33 561 099 427 `------------.-------:  X  AGAINST      |  \e/  There is no  |
| http://ymorin.is-a-geek.org/ | _/*\_ | / \ HTML MAIL    |   v   conspiracy.  |
'------------------------------^-------^------------------^--------------------'
_______________________________________________
buildroot mailing list
buildroot@buildroot.org
https://lists.buildroot.org/mailman/listinfo/buildroot

Re: [Buildroot] [PATCH 3/6] docs/website/support.html: document how to join irc channel from matrix

[Yann E. MORIN]

Marcus, All,

On 2024-02-06 11:52 +0100, Marcus Hoffmann via buildroot spake thusly:
> Signed-off-by: Marcus Hoffmann <buildroot@bubu1.eu>

Applied to master, thanks.

Regards,
Yann E. MORIN.

> ---
>  docs/website/support.html | 4 +++-
>  1 file changed, 3 insertions(+), 1 deletion(-)
> 
> diff --git a/docs/website/support.html b/docs/website/support.html
> index 9be816f836..13d63b13a9 100644
> --- a/docs/website/support.html
> +++ b/docs/website/support.html
> @@ -21,7 +21,9 @@
>  		<div class="col-sm-11">
>  		  <p>The Buildroot IRC channel is <a href="irc://irc.oftc.net/#buildroot">
>  		      #buildroot</a>, hosted on OFTC. If you do not have an IRC client, you can
> -		    use the <a href="https://www.oftc.net/WebChat/">OFTC web interface</a>.
> +		    use the <a href="https://www.oftc.net/WebChat/">OFTC web interface</a>. The
> +		    channel is also bridged to matrix as <a href="https://matrix.to/#/#_oftc_#buildroot:matrix.org">
> +		      #_oftc_#buildroot:matrix.org</a>.
>  		    When asking for help on IRC, share relevant logs or pieces of code using a code
>  		    sharing website.</p>
>  
> -- 
> 2.43.0
> 
> _______________________________________________
> buildroot mailing list
> buildroot@buildroot.org
> https://lists.buildroot.org/mailman/listinfo/buildroot

-- 
.-----------------.--------------------.------------------.--------------------.
|  Yann E. MORIN  | Real-Time Embedded | /"\ ASCII RIBBON | Erics' conspiracy: |
| +33 662 376 056 | Software  Designer | \ / CAMPAIGN     |  ___               |
| +33 561 099 427 `------------.-------:  X  AGAINST      |  \e/  There is no  |
| http://ymorin.is-a-geek.org/ | _/*\_ | / \ HTML MAIL    |   v   conspiracy.  |
'------------------------------^-------^------------------^--------------------'
_______________________________________________
buildroot mailing list
buildroot@buildroot.org
https://lists.buildroot.org/mailman/listinfo/buildroot

Re: [Buildroot] [PATCH 4/6] docs/website/support.html: document irc channel permission changes

[Yann E. MORIN]

Marcus, All,

On 2024-02-06 11:52 +0100, Marcus Hoffmann via buildroot spake thusly:
> The #buildroot IRC channel recently changed from only allowing
> registered users to join to allowing anyone to join but only allowing
> registered users to talk in the channel. This still avoids the spam
> problem on IRC while allowing an exception for users bridged from
> matrix.org. These already have a username registered on the matrix side
> and thus similar properties as a registered IRC user/nick.
> 
> The commands to set these options were:
> 
> * Set +q on all unregistered nicks: ~/mode #buildroot +q $~a~ this lets
>   people join but they can't talk
> * Set exempt on matrix hosts: ~/mode #buildroot +e $x:matrix.org~
> 
> Signed-off-by: Marcus Hoffmann <buildroot@bubu1.eu>

Applied to master, thanks.

Regards,
Yann E. MORIN.

> ---
>  docs/website/support.html | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/docs/website/support.html b/docs/website/support.html
> index 13d63b13a9..28873c6d76 100644
> --- a/docs/website/support.html
> +++ b/docs/website/support.html
> @@ -27,8 +27,8 @@
>  		    When asking for help on IRC, share relevant logs or pieces of code using a code
>  		    sharing website.</p>
>  
> -		  <p>Note that due to excessive spamming on IRC, the channel can only be
> -		    joined if you are a registered user with
> +		  <p>Note that due to excessive spamming on IRC, you can only talk in the
> +		    channel if you are a registered user with
>  		    <a href="https://www.oftc.net/Services/">OFTC NickServ</a>
>  		    service. Follow the instructions to register as a user with a password,
>  		    and then join the <code>#buildroot</code> channel.</p>
> -- 
> 2.43.0
> 
> _______________________________________________
> buildroot mailing list
> buildroot@buildroot.org
> https://lists.buildroot.org/mailman/listinfo/buildroot

-- 
.-----------------.--------------------.------------------.--------------------.
|  Yann E. MORIN  | Real-Time Embedded | /"\ ASCII RIBBON | Erics' conspiracy: |
| +33 662 376 056 | Software  Designer | \ / CAMPAIGN     |  ___               |
| +33 561 099 427 `------------.-------:  X  AGAINST      |  \e/  There is no  |
| http://ymorin.is-a-geek.org/ | _/*\_ | / \ HTML MAIL    |   v   conspiracy.  |
'------------------------------^-------^------------------^--------------------'
_______________________________________________
buildroot mailing list
buildroot@buildroot.org
https://lists.buildroot.org/mailman/listinfo/buildroot

Re: [Buildroot] [PATCH 5/6] docs/manual/contribute.adoc: link to git-send-email.io

[Yann E. MORIN]

Marcus, All,

On 2024-02-06 11:52 +0100, Marcus Hoffmann via buildroot spake thusly:
> https://git-send-email.io/ is a page maintained by sourcehut which
> explains how to setup git send-email on many OS's for many popular email
> providers.
> 
> Signed-off-by: Marcus Hoffmann <buildroot@bubu1.eu>

Applied to master, thanks.

Regards,
Yann E. MORIN.

> ---
>  docs/manual/contribute.adoc | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/docs/manual/contribute.adoc b/docs/manual/contribute.adoc
> index 2b90d13b41..684e9f4809 100644
> --- a/docs/manual/contribute.adoc
> +++ b/docs/manual/contribute.adoc
> @@ -369,7 +369,7 @@ $ git send-email origin/master
>  ---------------------
>  
>  Note that +git+ should be configured to use your mail account.
> -To configure +git+, see +man git-send-email+ or google it.
> +To configure +git+, see +man git-send-email+ or https://git-send-email.io/.
>  
>  If you do not use +git send-email+, make sure posted *patches are not
>  line-wrapped*, otherwise they cannot easily be applied. In such a case,
> -- 
> 2.43.0
> 
> _______________________________________________
> buildroot mailing list
> buildroot@buildroot.org
> https://lists.buildroot.org/mailman/listinfo/buildroot

-- 
.-----------------.--------------------.------------------.--------------------.
|  Yann E. MORIN  | Real-Time Embedded | /"\ ASCII RIBBON | Erics' conspiracy: |
| +33 662 376 056 | Software  Designer | \ / CAMPAIGN     |  ___               |
| +33 561 099 427 `------------.-------:  X  AGAINST      |  \e/  There is no  |
| http://ymorin.is-a-geek.org/ | _/*\_ | / \ HTML MAIL    |   v   conspiracy.  |
'------------------------------^-------^------------------^--------------------'
_______________________________________________
buildroot mailing list
buildroot@buildroot.org
https://lists.buildroot.org/mailman/listinfo/buildroot

Re: [Buildroot] [PATCH 6/6] docs/manual/contribute.adoc: mention sr.ht as an alternative for sending patches

[Yann E. MORIN]

Marcus, All,

On 2024-02-06 11:52 +0100, Marcus Hoffmann via buildroot spake thusly:
> Signed-off-by: Marcus Hoffmann <buildroot@bubu1.eu>
> ---
>  docs/manual/contribute.adoc | 8 ++++++++
>  1 file changed, 8 insertions(+)
> 
> diff --git a/docs/manual/contribute.adoc b/docs/manual/contribute.adoc
> index 684e9f4809..7d0611be28 100644
> --- a/docs/manual/contribute.adoc
> +++ b/docs/manual/contribute.adoc
> @@ -375,6 +375,14 @@ If you do not use +git send-email+, make sure posted *patches are not
>  line-wrapped*, otherwise they cannot easily be applied. In such a case,
>  fix your e-mail client, or better yet, learn to use +git send-email+.
>  
> +https://sr.ht also has a light-weight UI for
> +https://man.sr.ht/git.sr.ht/#sending-patches-upstream[preparing patchseries]
> +and can also send out the patches for you. There are a few drawbacks to
> +this, as you cannot edit your patches' status in Patchwork and you
> +currently can't edit your display name with which the match emails are
> +sent out but it is an option if you cannot get git send-email to work
> +with your mail provider (i.e. O365).

As seen IRL, I extended that with a blurb explicitly stating that it's
not the official way of sneding patches, just a fallback.

Applied to master, thanks.

Regards,
Yann E. MORIN.

>  ==== Cover letter
>  
>  If you want to present the whole patch set in a separate mail, add
> -- 
> 2.43.0
> 
> _______________________________________________
> buildroot mailing list
> buildroot@buildroot.org
> https://lists.buildroot.org/mailman/listinfo/buildroot

-- 
.-----------------.--------------------.------------------.--------------------.
|  Yann E. MORIN  | Real-Time Embedded | /"\ ASCII RIBBON | Erics' conspiracy: |
| +33 662 376 056 | Software  Designer | \ / CAMPAIGN     |  ___               |
| +33 561 099 427 `------------.-------:  X  AGAINST      |  \e/  There is no  |
| http://ymorin.is-a-geek.org/ | _/*\_ | / \ HTML MAIL    |   v   conspiracy.  |
'------------------------------^-------^------------------^--------------------'
_______________________________________________
buildroot mailing list
buildroot@buildroot.org
https://lists.buildroot.org/mailman/listinfo/buildroot