[PATCH] README: update/fix contribution guidelines

[PATCH] README: update/fix contribution guidelines

[Michael Opdenacker]

- Ask to CC the docs@lists.yoctoproject.org mailing list
- doc/README: fix the command to generate the manual

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
---
 README     | 5 +++++
 doc/README | 2 +-
 2 files changed, 6 insertions(+), 1 deletion(-)

diff --git a/README b/README
index 96e6007e..5034a9bf 100644
--- a/README
+++ b/README
@@ -26,6 +26,11 @@ branch, type:
 
     git send-email -M -1 --to bitbake-devel@lists.openembedded.org
 
+If you're sending a patch related to the BitBake manual, make sure you copy
+the Yocto Project documentation mailing list:
+
+    git send-email -M -1 --to bitbake-devel@lists.openembedded.org --to docs@lists.yoctoproject.org
+
 Mailing list:
 
     http://lists.openembedded.org/mailman/listinfo/bitbake-devel
diff --git a/doc/README b/doc/README
index cbb5215d..1f8e0f6e 100644
--- a/doc/README
+++ b/doc/README
@@ -47,7 +47,7 @@ To install all required packages run:
 
 To build the documentation locally, run:
 
- $ cd documentation
+ $ cd doc
  $ make html
 
 The resulting HTML index page will be _build/html/index.html, and you
-- 
2.25.1

Re: [bitbake-devel] [PATCH] README: update/fix contribution guidelines

[Martin Jansa]

[-- Attachment #1: Type: text/plain, Size: 1397 bytes --]

On Fri, Apr 23, 2021 at 06:31:08PM +0200, Michael Opdenacker wrote:
> - Ask to CC the docs@lists.yoctoproject.org mailing list

it adds 2nd --to

which is probably fine, just doesn't match with commit message

> - doc/README: fix the command to generate the manual
> 
> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
> ---
>  README     | 5 +++++
>  doc/README | 2 +-
>  2 files changed, 6 insertions(+), 1 deletion(-)
> 
> diff --git a/README b/README
> index 96e6007e..5034a9bf 100644
> --- a/README
> +++ b/README
> @@ -26,6 +26,11 @@ branch, type:
>
>      git send-email -M -1 --to bitbake-devel@lists.openembedded.org
>
> +If you're sending a patch related to the BitBake manual, make sure you copy
> +the Yocto Project documentation mailing list:
> +
> +    git send-email -M -1 --to bitbake-devel@lists.openembedded.org --to docs@lists.yoctoproject.org
> +
>  Mailing list:
>
>      http://lists.openembedded.org/mailman/listinfo/bitbake-devel
> diff --git a/doc/README b/doc/README
> index cbb5215d..1f8e0f6e 100644
> --- a/doc/README
> +++ b/doc/README
> @@ -47,7 +47,7 @@ To install all required packages run:
>
>  To build the documentation locally, run:
>
> - $ cd documentation
> + $ cd doc
>   $ make html
>
>  The resulting HTML index page will be _build/html/index.html, and you
> -- 
> 2.25.1
> 

> 
> 
> 


[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 201 bytes --]

Re: [bitbake-devel] [PATCH] README: update/fix contribution guidelines

[Michael Opdenacker]

On 4/23/21 6:34 PM, Martin Jansa wrote:
> On Fri, Apr 23, 2021 at 06:31:08PM +0200, Michael Opdenacker wrote:
>> - Ask to CC the docs@lists.yoctoproject.org mailing list
> it adds 2nd --to
>
> which is probably fine, just doesn't match with commit message


Oops, I'll fix this. Good catch!

Thanks

Michael.

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

Re: [bitbake-devel] [PATCH] README: update/fix contribution guidelines

[Martin Jansa]

[-- Attachment #1: Type: text/plain, Size: 2452 bytes --]

On Fri, Apr 23, 2021 at 06:34:41PM +0200, Martin Jansa via lists.openembedded.org wrote:
> On Fri, Apr 23, 2021 at 06:31:08PM +0200, Michael Opdenacker wrote:
> > - Ask to CC the docs@lists.yoctoproject.org mailing list
> 
> it adds 2nd --to
> 
> which is probably fine, just doesn't match with commit message

And more surprisingly this e-mail to docs@lists.yoctoproject.org was
rejected with:


Message not delivered
Your message couldn't be delivered to docs@lists.yoctoproject.org
because the remote server is misconfigured. See technical details below
for more information.
LEARN MORE
WarningThis link will take you to a third-party site

The response from the remote server was:
510 5.1.1 Your email address, martin.jansa@gmail.com, is not subscribed
to that group. To subscribe, send an email to
docs+subscribe@lists.yoctoproject.org, or visit
https://lists.yoctoproject.org/g/docs


Not sure if it's really misconfigured or if it's just quite confusing
way of gmail showing that I'm not subscribed (which is shown in small
font bellow big warning box about misconfiguration :/.

https://imgur.com/GMDE3IQ.png

Regards,

> > - doc/README: fix the command to generate the manual
> > 
> > Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
> > ---
> >  README     | 5 +++++
> >  doc/README | 2 +-
> >  2 files changed, 6 insertions(+), 1 deletion(-)
> > 
> > diff --git a/README b/README
> > index 96e6007e..5034a9bf 100644
> > --- a/README
> > +++ b/README
> > @@ -26,6 +26,11 @@ branch, type:
> >
> >      git send-email -M -1 --to bitbake-devel@lists.openembedded.org
> >
> > +If you're sending a patch related to the BitBake manual, make sure you copy
> > +the Yocto Project documentation mailing list:
> > +
> > +    git send-email -M -1 --to bitbake-devel@lists.openembedded.org --to docs@lists.yoctoproject.org
> > +
> >  Mailing list:
> >
> >      http://lists.openembedded.org/mailman/listinfo/bitbake-devel
> > diff --git a/doc/README b/doc/README
> > index cbb5215d..1f8e0f6e 100644
> > --- a/doc/README
> > +++ b/doc/README
> > @@ -47,7 +47,7 @@ To install all required packages run:
> >
> >  To build the documentation locally, run:
> >
> > - $ cd documentation
> > + $ cd doc
> >   $ make html
> >
> >  The resulting HTML index page will be _build/html/index.html, and you
> > -- 
> > 2.25.1
> > 
> 
> > 
> > 
> > 
> 



> 
> 
> 


[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 201 bytes --]

Re: [bitbake-devel] [PATCH] README: update/fix contribution guidelines

[Michael Opdenacker]

Hi Martin,

On 4/23/21 6:41 PM, Martin Jansa wrote:
> On Fri, Apr 23, 2021 at 06:34:41PM +0200, Martin Jansa via lists.openembedded.org wrote:
>> On Fri, Apr 23, 2021 at 06:31:08PM +0200, Michael Opdenacker wrote:
>>> - Ask to CC the docs@lists.yoctoproject.org mailing list
>> it adds 2nd --to
>>
>> which is probably fine, just doesn't match with commit message
> And more surprisingly this e-mail to docs@lists.yoctoproject.org was
> rejected with:
>
>
> Message not delivered
> Your message couldn't be delivered to docs@lists.yoctoproject.org
> because the remote server is misconfigured. See technical details below
> for more information.
> LEARN MORE
> WarningThis link will take you to a third-party site

Oops, that's ugly indeed.  Unfortunately, our lists are hosted on
Groups.io, so our ability to fix this is limited.

>
> The response from the remote server was:
> 510 5.1.1 Your email address, martin.jansa@gmail.com, is not subscribed
> to that group. To subscribe, send an email to
> docs+subscribe@lists.yoctoproject.org, or visit
> https://lists.yoctoproject.org/g/docs


This is also a bit uncomfortable to ask people to do us a favor and CC a
list that only accepts post from members...

Thoughts anyone?

Cheers,

Michael.

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

Re: [docs] [bitbake-devel] [PATCH] README: update/fix contribution guidelines

[Nicolas Dechesne]

[-- Attachment #1: Type: text/plain, Size: 2039 bytes --]

On Fri, Apr 23, 2021 at 8:00 PM Michael Opdenacker <
michael.opdenacker@bootlin.com> wrote:

> Hi Martin,
>
> On 4/23/21 6:41 PM, Martin Jansa wrote:
> > On Fri, Apr 23, 2021 at 06:34:41PM +0200, Martin Jansa via
> lists.openembedded.org wrote:
> >> On Fri, Apr 23, 2021 at 06:31:08PM +0200, Michael Opdenacker wrote:
> >>> - Ask to CC the docs@lists.yoctoproject.org mailing list
> >> it adds 2nd --to
> >>
> >> which is probably fine, just doesn't match with commit message
> > And more surprisingly this e-mail to docs@lists.yoctoproject.org was
> > rejected with:
> >
> >
> > Message not delivered
> > Your message couldn't be delivered to docs@lists.yoctoproject.org
> > because the remote server is misconfigured. See technical details below
> > for more information.
> > LEARN MORE
> > WarningThis link will take you to a third-party site
>
> Oops, that's ugly indeed.  Unfortunately, our lists are hosted on
> Groups.io, so our ability to fix this is limited.
>
> >
> > The response from the remote server was:
> > 510 5.1.1 Your email address, martin.jansa@gmail.com, is not subscribed
> > to that group. To subscribe, send an email to
> > docs+subscribe@lists.yoctoproject.org, or visit
> > https://lists.yoctoproject.org/g/docs
>
>
> This is also a bit uncomfortable to ask people to do us a favor and CC a
> list that only accepts post from members...
>
> Thoughts anyone?
>

The list was misconfigured. For all our open lists we typically enable all
registered members to post, which wasn't done for the docs@lists.yp.org
list. I've now changed it. That means that anyone registered on
lists.yoctoproject.org will be able to post. It still means that if someone
is only registered on lists.openembedded.org, but not on
lists.yoctoproject.org , then their message will be bounced.. but that
should be fine for most of our users.


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

[-- Attachment #2: Type: text/html, Size: 3455 bytes --]