Re: [lbwww][PATCH v2] Better instructions to create patches

[Denis 'GNUtoo' Carikli]

On Wed, 29 Mar 2023 15:07:26 +0200
Adrien Bourmault <neox@a-lec.org> wrote:

> Signed-off-by: Adrien Bourmault <neox@a-lec.org>
> ---
>  site/git.md | 26 +++++++++++++++++++-------
>  1 file changed, 19 insertions(+), 7 deletions(-)
> 
> diff --git a/site/git.md b/site/git.md
> index 4de7ce3..c3c42dc 100644
> --- a/site/git.md
> +++ b/site/git.md
> @@ -69,7 +69,7 @@ Download it like so:
>  
>      git clone https://git.sr.ht/~libreboot/lbwww
>  
> -Images are hosted on <https://libreboot.srht.site/img/> and
> available in a separate +Images are hosted on
> <https://libreboot.at/img/> and available in a separate repository:
>      git clone https://git.sr.ht/~libreboot/lbwww-img
> @@ -83,14 +83,14 @@ site generator project.
Apparently the html files still use https://libreboot.srht.site/img/
for the images. And the libreboot.srht.site works fine but
in libreboot.at, the images are broken somehow (sourcehut is probably
blocking them for some reasons).

Since the original Libreboot had a separate infrastructure just for
hosting the images and that we don't, a way out would probably be to
refer to images by relative path.

This would also help with testing as users would be able to test with
local images (the wrapper build system for the website is already ready
for that).

>  GNU+Linux is generally recommended as the OS of choice, for Libreboot
>  development. However, BSD operating systems also boot on Libreboot
> machines. 
> -Send patches
> +Send patches & contribute
>  ------------
>  
>  You can submit your patches to the 
> @@ -156,6 +156,18 @@ A simple guide to properly configure your git
> installation to send emails has been made by
> [sourcehut](https://git-send-email.io/) or you can use the [sourcehut
> interface](https://man.sr.ht/git.sr.ht/#sending-patches-upstream) to
> create patches. +You'll have to specify the mailing list address:
> +     
> +     git config --local sendemail.to
> ~libreboot/libreboot-devel@lists.sr.ht +
> +Since the mailing list accepts patches for all the repositories we
> manage, please specify which repository your patch is for. To do
> this, you'll need to use: +
> +     git config format.subjectPrefix "name_of_the_repo][PATCH"
> +
> +Please also sign-off your patches, which you can configure with:
> +
> +     git config format.signOff yes
Here it would probably be best to somehow mention that the git config
needs to be done before following the git-send-email.io instructions.

An idea here could be to split the "Send patches & contribute" part
in a separate commit and either rework a bit the instructions to tell
to do git config before, or keep it as-is and fix the order in a
subsequent patch.

The following could also go inside that patch or be a separate patch:
>  In Git, for author name and email address, you do not have to use
> identifying
 data. You can use Libreboot Contributor and your email address could be
> -specified as contributor@libreboot.srht.site. You are permitted to
> do this, if
+specified as contributor@libreboot.at. You are permitted to do this, if
[...]

As for the images url change, I think it's better to keep them as-is as
they look strange and broken, and since the images are broken on
libreboot.at, it is probably better to reflect that somehow than having
instructions that look fine but that are silently broken as
contributors would wonder if they broke it, if there is something wrong
with their setup, etc.

Denis.

pgpe2N_vMmxRh.pgp
Description: OpenPGP digital signature