summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorNicolas Dechesne <nicolas.dechesne@linaro.org>2021-04-07 18:35:06 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2021-04-09 15:24:46 +0100
commitddc9e2fd33abe6a0de7b4e0dacdb6f530ee99871 (patch)
treef9bc3201569426e76efba97b3a50e15e20580abf
parentc380ba5a177de32e97820279685c4af6f837c010 (diff)
downloadpoky-ddc9e2fd33abe6a0de7b4e0dacdb6f530ee99871.tar.gz
poky-ddc9e2fd33abe6a0de7b4e0dacdb6f530ee99871.tar.bz2
poky-ddc9e2fd33abe6a0de7b4e0dacdb6f530ee99871.zip
docs: add a top level page for bitbake documentation
The top level index file includes a link to the Bitbake documentation. This link is static, however the location of the Bitbake documentation depends on the intersphinx configuration. As such, when looking at an old YP docs release, the link to the bitbake documentation is always the same (and wrong). Since we cannot use a cross reference in a toc index, this patch creates an intermediate page for bitbake documentation, and in that page we insert the right link to the bibtake documentation (e.g. :doc:`bitbake:index`) which will be adjusted dynamically based on intersphinx config. (From yocto-docs rev: 4f7f451df266a307b34bf145b29291ca85eb882f) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Tested-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/bitbake.rst19
-rw-r--r--documentation/index.rst2
2 files changed, 20 insertions, 1 deletions
diff --git a/documentation/bitbake.rst b/documentation/bitbake.rst
new file mode 100644
index 0000000000..7702f9322c
--- /dev/null
+++ b/documentation/bitbake.rst
@@ -0,0 +1,19 @@
+.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
+
+=====================
+BitBake Documentation
+=====================
+
+|
+
+BitBake was originally a part of the OpenEmbedded project. It was inspired by
+the Portage package management system used by the Gentoo Linux distribution. In
+2004, the OpenEmbedded project was split the project into two distinct pieces:
+
+- BitBake, a generic task executor
+- OpenEmbedded, a metadata set utilized by BitBake
+
+Today, BitBake is the primary build tool of OpenEmbedded based projects, such as
+the Yocto Project.
+
+The BitBake documentation can be found :doc:`here <bitbake:index>`.
diff --git a/documentation/index.rst b/documentation/index.rst
index 9f41daf4b4..6aeeb2197b 100644
--- a/documentation/index.rst
+++ b/documentation/index.rst
@@ -34,7 +34,7 @@ Welcome to the Yocto Project Documentation
Application Development and the Extensible SDK (eSDK) <sdk-manual/index>
Toaster Manual <toaster-manual/index>
Test Environment Manual <test-manual/index>
- Bitbake User Manual <https://docs.yoctoproject.org/bitbake>
+ bitbake
.. toctree::
:maxdepth: 1