Skip to contentSkip to conversation

utils/readme.txt: expand check-package description

PATCH Applied Marcus Hoffmann via buildroot 2 participants 12 messages Feb 6, 2024

lore
Share & tools
lore
#0 lore raw

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

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

---
 utils/readme.txt | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)
utils/readme.txt +5 -2
index 3e8833c4ea..d5cda70bfc 100644
@@ -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
Signature · 6 lines
2.43.0

_______________________________________________
buildroot mailing list
[email protected]
https://lists.buildroot.org/mailman/listinfo/buildroot
#1 lore raw

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

---
 utils/readme.txt | 4 ++++
 1 file changed, 4 insertions(+)
utils/readme.txt +4 -0
index d5cda70bfc..2cb6b0af9b 100644
@@ -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
Signature · 6 lines
2.43.0

_______________________________________________
buildroot mailing list
[email protected]
https://lists.buildroot.org/mailman/listinfo/buildroot
#2 lore raw

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

Marcus, All,

On 2024-02-06 11:52 +0100, Marcus Hoffmann via buildroot spake thusly:

Quoted 10 lines
---
 utils/readme.txt | 4 ++++
 1 file changed, 4 insertions(+)
utils/readme.txt +0 -0
index d5cda70bfc..2cb6b0af9b 100644

utils/readme.txt check-package · line 23

Quoted 6 lines
utils/readme.txt +3 -0
@@ -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.

Quoted 10 lines
utils/readme.txt +0 -0
 genrandconfig
     a script that generates a random configuration, used by the autobuilders
     (http://autobuild.buildroot.org). It selects a random toolchain from
Signature · 6 lines
2.43.0

_______________________________________________
buildroot mailing list
[email protected]
https://lists.buildroot.org/mailman/listinfo/buildroot
Signature · 10 lines
.-----------------.--------------------.------------------.--------------------.
|  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
[email protected]
https://lists.buildroot.org/mailman/listinfo/buildroot
#3 lore raw

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

In reply to Marcus Hoffmann via buildroot
---
 docs/website/support.html | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)
docs/website/support.html +3 -1
index 9be816f836..13d63b13a9 100644
@@ -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>
 
Signature · 6 lines
2.43.0

_______________________________________________
buildroot mailing list
[email protected]
https://lists.buildroot.org/mailman/listinfo/buildroot
#4 lore raw

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

Marcus, All,

On 2024-02-06 11:52 +0100, Marcus Hoffmann via buildroot spake thusly:

Quoted 1 line

Applied to master, thanks.

Regards,
Yann E. MORIN.

Quoted 26 lines
---
 docs/website/support.html | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)
docs/website/support.html +3 -1
index 9be816f836..13d63b13a9 100644
@@ -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>
 
Signature · 6 lines
2.43.0

_______________________________________________
buildroot mailing list
[email protected]
https://lists.buildroot.org/mailman/listinfo/buildroot
Signature · 10 lines
.-----------------.--------------------.------------------.--------------------.
|  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
[email protected]
https://lists.buildroot.org/mailman/listinfo/buildroot
#5 lore raw

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

In reply to 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~

---
 docs/website/support.html | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
docs/website/support.html +2 -2
index 13d63b13a9..28873c6d76 100644
@@ -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>
Signature · 6 lines
2.43.0

_______________________________________________
buildroot mailing list
[email protected]
https://lists.buildroot.org/mailman/listinfo/buildroot
#6 lore raw

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

Marcus, All,

On 2024-02-06 11:52 +0100, Marcus Hoffmann via buildroot spake thusly:

Quoted 7 lines

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.

Quoted 7 lines

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~

Applied to master, thanks.

Regards,
Yann E. MORIN.

Quoted 26 lines
---
 docs/website/support.html | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
docs/website/support.html +2 -2
index 13d63b13a9..28873c6d76 100644
@@ -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>
Signature · 6 lines
2.43.0

_______________________________________________
buildroot mailing list
[email protected]
https://lists.buildroot.org/mailman/listinfo/buildroot
Signature · 10 lines
.-----------------.--------------------.------------------.--------------------.
|  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
[email protected]
https://lists.buildroot.org/mailman/listinfo/buildroot
#7 lore raw

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

In reply to 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.

---
 docs/manual/contribute.adoc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
docs/manual/contribute.adoc +1 -1
index 2b90d13b41..684e9f4809 100644
@@ -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,
Signature · 6 lines
2.43.0

_______________________________________________
buildroot mailing list
[email protected]
https://lists.buildroot.org/mailman/listinfo/buildroot
#8 lore raw

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

Marcus, All,

On 2024-02-06 11:52 +0100, Marcus Hoffmann via buildroot spake thusly:

Quoted 5 lines

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.

Applied to master, thanks.

Regards,
Yann E. MORIN.

Quoted 24 lines
---
 docs/manual/contribute.adoc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
docs/manual/contribute.adoc +1 -1
index 2b90d13b41..684e9f4809 100644
@@ -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,
Signature · 6 lines
2.43.0

_______________________________________________
buildroot mailing list
[email protected]
https://lists.buildroot.org/mailman/listinfo/buildroot
Signature · 10 lines
.-----------------.--------------------.------------------.--------------------.
|  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
[email protected]
https://lists.buildroot.org/mailman/listinfo/buildroot
#9 lore raw

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

In reply to Marcus Hoffmann via buildroot
---
 docs/manual/contribute.adoc | 8 ++++++++
 1 file changed, 8 insertions(+)
docs/manual/contribute.adoc +8 -0
index 684e9f4809..7d0611be28 100644
@@ -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
Signature · 6 lines
2.43.0

_______________________________________________
buildroot mailing list
[email protected]
https://lists.buildroot.org/mailman/listinfo/buildroot
#10 lore raw

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

Marcus, All,

On 2024-02-06 11:52 +0100, Marcus Hoffmann via buildroot spake thusly:

Quoted 10 lines
---
 docs/manual/contribute.adoc | 8 ++++++++
 1 file changed, 8 insertions(+)
docs/manual/contribute.adoc +0 -0
index 684e9f4809..7d0611be28 100644

docs/manual/contribute.adoc If you do not use +git send-email+, make sure posted *patches are not · line 384

Quoted 10 lines
docs/manual/contribute.adoc +7 -0
@@ -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.

Quoted 10 lines
docs/manual/contribute.adoc +0 -0
 ==== Cover letter
 
 If you want to present the whole patch set in a separate mail, add
Signature · 6 lines
2.43.0

_______________________________________________
buildroot mailing list
[email protected]
https://lists.buildroot.org/mailman/listinfo/buildroot
Signature · 10 lines
.-----------------.--------------------.------------------.--------------------.
|  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
[email protected]
https://lists.buildroot.org/mailman/listinfo/buildroot
#11 lore raw
In reply to Marcus Hoffmann via buildroot

Marcus, All,

On 2024-02-06 11:52 +0100, Marcus Hoffmann via buildroot spake thusly:

Quoted 4 lines

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

Applied to master, thanks.

Regards,
Yann E. MORIN.

Quoted 29 lines
---
 utils/readme.txt | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)
utils/readme.txt +5 -2
index 3e8833c4ea..d5cda70bfc 100644
@@ -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
Signature · 6 lines
2.43.0

_______________________________________________
buildroot mailing list
[email protected]
https://lists.buildroot.org/mailman/listinfo/buildroot
Signature · 10 lines
.-----------------.--------------------.------------------.--------------------.
|  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
[email protected]
https://lists.buildroot.org/mailman/listinfo/buildroot