aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2021-04-23 19:54:29 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2021-04-26 15:23:21 +0100
commit8332664f9141d2c12f70589ebd2eed7eeddd8f77 (patch)
tree5c259eff3ac382333d49ddf88fbb595aa3b494bb
parent784a904faffac723ddf58ba765b9dd11ac068de5 (diff)
downloadbitbake-8332664f9141d2c12f70589ebd2eed7eeddd8f77.tar.gz
README: update/fix contribution guidelines
- 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> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--README5
-rw-r--r--doc/README2
2 files changed, 6 insertions, 1 deletions
diff --git a/README b/README
index 96e6007e7..64206de8a 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 cbb5215d3..1f8e0f6eb 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