diff options
author | Nicolas Dechesne <nicolas.dechesne@linaro.org> | 2021-04-07 18:35:06 +0200 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2021-04-09 15:24:46 +0100 |
commit | ddc9e2fd33abe6a0de7b4e0dacdb6f530ee99871 (patch) | |
tree | f9bc3201569426e76efba97b3a50e15e20580abf | |
parent | c380ba5a177de32e97820279685c4af6f837c010 (diff) | |
download | poky-ddc9e2fd33abe6a0de7b4e0dacdb6f530ee99871.tar.gz |
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.rst | 19 | ||||
-rw-r--r-- | documentation/index.rst | 2 |
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 @@ | |||
1 | .. SPDX-License-Identifier: CC-BY-SA-2.0-UK | ||
2 | |||
3 | ===================== | ||
4 | BitBake Documentation | ||
5 | ===================== | ||
6 | |||
7 | | | ||
8 | |||
9 | BitBake was originally a part of the OpenEmbedded project. It was inspired by | ||
10 | the Portage package management system used by the Gentoo Linux distribution. In | ||
11 | 2004, the OpenEmbedded project was split the project into two distinct pieces: | ||
12 | |||
13 | - BitBake, a generic task executor | ||
14 | - OpenEmbedded, a metadata set utilized by BitBake | ||
15 | |||
16 | Today, BitBake is the primary build tool of OpenEmbedded based projects, such as | ||
17 | the Yocto Project. | ||
18 | |||
19 | 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 | |||
34 | Application Development and the Extensible SDK (eSDK) <sdk-manual/index> | 34 | Application Development and the Extensible SDK (eSDK) <sdk-manual/index> |
35 | Toaster Manual <toaster-manual/index> | 35 | Toaster Manual <toaster-manual/index> |
36 | Test Environment Manual <test-manual/index> | 36 | Test Environment Manual <test-manual/index> |
37 | Bitbake User Manual <https://docs.yoctoproject.org/bitbake> | 37 | bitbake |
38 | 38 | ||
39 | .. toctree:: | 39 | .. toctree:: |
40 | :maxdepth: 1 | 40 | :maxdepth: 1 |