[PATCH v2] README: update/fix contribution guidelines

[PATCH v2] 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..64206de8 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 --cc 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: [docs] [PATCH v2] README: update/fix contribution guidelines

[Quentin Schulz]

Hi Michael,

On Fri, Apr 23, 2021 at 07:54:29PM +0200, Michael Opdenacker wrote:
> - Ask to CC the docs@lists.yoctoproject.org mailing list
> - doc/README: fix the command to generate the manual
> 

Usually, when you have to make a list in a commit log of things you did,
it's telling you that there should be multiple commits. Here you two
changes are not related.

Anyway, that's just me picking nits, I wouldn't have replied if it wasn't
to give my

Reviewed-by: Quentin Schulz <foss@0leil.net>

Thanks,
Quentin

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

[Michael Opdenacker]

Hi Quentin,

On 4/26/21 10:43 AM, Quentin Schulz wrote:
> Hi Michael,
>
> On Fri, Apr 23, 2021 at 07:54:29PM +0200, Michael Opdenacker wrote:
>> - Ask to CC the docs@lists.yoctoproject.org mailing list
>> - doc/README: fix the command to generate the manual
>>
> Usually, when you have to make a list in a commit log of things you did,
> it's telling you that there should be multiple commits. Here you two
> changes are not related.
>
> Anyway, that's just me picking nits, I wouldn't have replied if it wasn't
> to give my
>
> Reviewed-by: Quentin Schulz <foss@0leil.net>


Many thanks for your review and for your kind advice. Indeed, the
changes were related to documentation, but independent from each other.
I'll remember that next time

Thanks again, and thanks to Richard for having merged this change into
"master"!

Michael.

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