summaryrefslogtreecommitdiff
path: root/poky/documentation/README
diff options
context:
space:
mode:
authorPatrick Williams <patrick@stwcx.xyz>2021-01-30 17:17:16 +0300
committerPatrick Williams <patrick@stwcx.xyz>2021-01-30 17:19:34 +0300
commitbf91d30bc84e7159f13d32da1bc4007fbfdb8a6e (patch)
tree25a46ba775bf2e8d4aab4c329446eefc6d326551 /poky/documentation/README
parent94a70a0f73533c9af5a5a15942539e8eda1a6a5e (diff)
downloadopenbmc-bf91d30bc84e7159f13d32da1bc4007fbfdb8a6e.tar.xz
subtree updates
poky: 424296bf9b..7ea41de137: Adrian Herrera (1): scripts: oe-run-native, fix *-native directories Alexander Kanavin (8): meta/lib/oe/reproducible.py: gitsm:// works just as fine as git:// for timestamps llvm: fix reproducibility ruby: fix reproducibility webkitgtk: fix reproducibility ffmpeg: fix reproducibility serf: do not install the static library llvm: sort the lists in generated source reproducibibly valgrind: exclude bar_bad/bar_bad_xml from ptests Andrej Valek (2): kernel-dummy: fix executing unexpected tasks python3: fix CVE-2019-20907 Andrey Mozzhuhin (1): toolchain-shar-extract.sh: Handle special characters in script path Anuj Mittal (2): distutils-common-base: fix LINKSHARED expansion mesa: add more details to elf-tls patch Armin Kuster (2): xorg: Security fix for CVE-2020-14345 glibc: Security fix for CVE-2020-29573 Brett Warren (1): libffi: add patch to revert clang VFP workaround Bruce Ashfield (20): kernel: provide module.lds for out of tree builds in v5.10+ kernel: relocate copy of module.lds to module compilation task linux-yocto/5.4: update to v5.4.71 linux-yocto/5.4: update to v5.4.72 linux-yocto/5.4: update to v5.4.73 linux-yocto/5.4: config cleanup / warnings linux-yocto/5.4: update to v5.4.75 linux-yocto/5.4: perf: Alias SYS_futex with SYS_futex_time64 on 32-bit arches with 64bit time_t linux-yocto/5.4: update to v5.4.78 lttng-modules: add post 2.11.6 patches linux-yocto-rt/5.4: update to -rt44 linux-yocto/5.4: update to v5.4.80 linux-yocto/cfg: qemuppc: set CONFIG_SCSI to '=y' linux-yocto/5.4: update to v5.4.82 linux-yocto/cfg: qemuarm64-gfx.cfg: add CONFIG_INPUT_UINPUT linux-yocto/5.4: update to v5.4.83 linux-yocto/5.4/cfg: fix -tiny warnings linux-yocto/5.4/cfg: fix FIRMWARE_LOADER warnings linux-yocto/5.4: update to v5.4.85 linux-yocto/5.4: update to v5.4.87 Changqing Li (2): buildtools-tarball: add wic dependency into extended buildtools libexif: fix CVE-2020-0198; CVE-2020-0452 Chris Laplante (1): systemd.bbclass: improve error message when a service unit specified in SYSTEMD_SERVICE is not found Christopher Larson (2): grub-efi-cfg: exclude OVERRIDES from build_efi_cfg vardeps uboot-extlinux-config: exclude OVERRIDES from do_create_extlinux_config vardeps Daniel Ammann (1): wic: fix typo Diego Sueiro (1): modutils-initscripts: Use depmod -a when modules.dep is empty Dmitry Baryshkov (5): linux-firmware: upgrade 20201022 -> 20201118 linux-firmware: package ath11k firmware linux-firmware: upgrade 20201118 -> 20201218 linux-firmware: package firmware for Lontium lt9611uxc bridge perl: fix installation failure because of shell issue Fedor Ross (2): sysvinit: remove bashism to be compatible with dash eudev: remove bashism to be compatible with dash Gratian Crisan (1): kernel-module-split.bbclass: fix kernel modules getting marked as CONFFILES Hongxu Jia (1): glib-networking/btrfs-tools/dosfstools/parted/bmap-tools/libsoup-2.4: add nativesdk support Joshua Watt (4): ref-variables: Given example for naming sources ref-manual: Document wic --offset option documentation: Add Pipenv support classes/waf: Add build and install arguments Khem Raj (1): initscripts: use quotes for shell variable comparision Lee Chee Yang (7): go: update to 1.14.12 glibc: fix CVE-2020-29562 qemu: fix CVE-2020-25723 binutils: fix CVE-2020-16592/16598 wic/direct/kparser: ensure fsuuid for vfat and msdos align with format gdk-pixbuf: fix CVE-2020-29385 curl: fix CVE-2020-8231/8284/8285/8286 Loic Domaigne (1): roofs_*.bbclass: fix missing vardeps for do_rootfs Mans Rullgard (1): boost: drop arm-intrinsics.patch Marek Vasut (2): meta: toolchain-shar-relocate.sh: Do not use $target_sdk_dir as regex meta: toolchain-shar-relocate.sh: Filter out post-relocate-setup script Mark Jonas (1): libsdl2: Add directfb to PACKAGECONFIG rdepends Max Krummenacher (1): linux-firmware: rdepend on license for all nvidia packages Maxime Roussin-BĂ©langer (1): meta: add missing descriptions in some support recipes Mert Kirpici (1): bitbake: doc/conf.py: add missing import sys Michael Ho (1): license_image.bbclass: fix missing recipeinfo on self Mikko Rapeli (4): glibc: update to 2.31 stable tree head glib-2.0: add patch for CVE-2020-35457 systemd: update from 244.3 to 244.5 stable release zip: whitelist CVE-2018-13410 and CVE-2018-13684 Milan Shah (1): oe-pkgdata-util: Added a test to verify oe-pkgdata-util without parameters Naoki Hayama (1): dev/test/ref-manual: Fix typos Nathan Rossi (2): ncurses: Prevent LDFLAGS being emitted in .pc files coreutils: enable xattrs by default for nativesdk Nicolas Dechesne (16): bitbake: sphinx: import sphinx docs bitbake: sphinx: undo (bitbake-user-manual: Remove TERM from BB_HASHBASE_WHITELIST example) bitbake: sphinx: partial undo (bitbake-user-manual: update perforce fetcher docs) sphinx: import docs sphinx: undo (ref-system-requirements: update supported hosts lists) sphinx: reintroduce changes for 3.1.1, 3.1.2, 3.1.3 and 3.1.4 sphinx: remove test-manual sphinx: fix up some trademark and branding issues sphinx: remove DocBook files sphinx: rename Makefile.sphinx sdk-manual: use built-in footnotes sphinx: add 3.1.3 and 3.0.4 release in the switcher poky.yaml: remove unused variables Makefile: enable parallel build conf.py: set version to 3.1.4 sphinx: update link to bitbake docs Ovidiu Panait (2): timezone: upgrade to 2020e timezone: upgrade to 2020f Paul Barker (2): conf.py: Improve TOC and Outline depth in PDF output selftest: Add argument to keep build dir Paul Eggleton (5): ref-manual: add reference anchors for each QA check ref-manual: fix for features_check class change ref-manual: add IMAGE_VERSION_SUFFIX variable ref-manual: add IMAGE_NAME_SUFFIX variable ref-manual: add IMAGE_LINK_NAME Peter Kjellerstedt (1): apr-util: Only specify --with-dbm=gdbm if gdbm support is enabled Quentin Schulz (20): docs: ref-manual: ref-variables: fix one-letter pointer links in glossary docs: ref-manual: ref-variables: fix alphabetical order in glossary docs: ref-manual: ref-variables: add links to terms in glossary docs: poky.yaml: use HTTPS for links docs: ref-manual: indentation, links and highlights fixes docs: remove OE_INIT_FILE variable docs: ref-manual: fix typos docs: ref-manual: migration-2.3: specify 2.3 version instead of DISTRO docs: ref-manual: ref-classes: remove dropped tinderclient class docs: ref-manual: ref-system-requirements: update requirements to build Sphinx docs docs: sphinx: yocto-vars: rebuild files when poky.yaml has changed docs: poky.yaml: fix identation in host packages variables docs: dev-manual-common-tasks: remove paragraph about race when missing DEPENDS docs: dev-manual-common-tasks: update python webserver example to python3 docs: dev-manual: fix typos, highlights, indentation and links docs: ref-manual: ref-terms: add links to terms in glossary docs: bsp-guide: bsp: fix typos, highlights and links docs: kernel-dev: fix typos, highlights and links docs: kernel-dev-common: add .patch file extension to SRC_URI files docs: kernel-dev-faq: update outdated RDEPENDS_kernel-base Richard Purdie (20): fs-perms: Ensure /usr/src/debug/ file modes are correct e2fsprogs: Fix a ptest permissions determinism issue lz4: Use the new branch naming from upstream metadata_scm: Fix signature handling of METADATA_REVISION and METADATA_BRANCH grub: Fix build reproducibility issue grub: Add second fix for determinism issue u-boot-tools: Fix reproducibility issue groff: Fix reproducibility issue man-db: Avoid reproducibility failures after fixing groff-native cups: Mark CVE-2009-0032 as a non-issue cups: Mark CVE-2008-1033 as a non-issue docs: Fix license CC-BY-2.0-UK -> CC-BY-SA-2.0-UK ref-manual/faq: Add entry for why binaries are changed in images dev-manual: Add a note about prelink changing prebuild binaries oeqa/commands: Ensure sync can be found regardless of PATH grub: Further reproducibility fix man-db: Fix reproducibility issue gcc: Fix mangled patch bitbake: data_smart: Ensure hash reflects vardepvalue flags correctly linuxloader: Avoid confusing string concat errors Robert Joslyn (2): openssl: Update to 1.1.1i ppp: Whitelist CVE-2020-15704 Robert P. J. Day (3): ref-manual/ref-variables: "PACKAGE_FEEDS_ARCHS" -> "PACKAGE_FEED_ARCHS" README: "yocto-project-qs" -> "brief-yoctoprojectqs" adt-manual: delete obsolete ADT manual, and related content Robert Yang (5): buildtools-tarball.bb: Fix PATH for environment setup script ncurses: Make ncurses-tools depend on ncurses-terminfo-base minicom: RDEPENDS on ncurses-terminfo-base archiver.bbclass: Fix --runall=deploy_archives for images weston: Fix PACKAGECONFIG for remoting Ross Burton (17): bitbake: taskexp: update for GTK API changes cve-check: show real PN/PV python3: add CVE-2007-4559 to whitelist gstreamer1.0-rtsp-server: set CVE_PRODUCT gstreamer1.0-plugins-base: set CVE_PRODUCT oeqa/devtool: use Yocto mirror for pv-1.5.3 tarball devtool: remove unused variable image_types: sort tarball file listings cve-update-db-native: handle all-wildcard versions coreutils: add SUSE-specific issues to CVE whitelist kernel: set COMPATIBLE_HOST to *-linux ncurses: remove config.cache wic-image-minimal: only depend on syslinux on x86 targets lib/oe/qa: handle the 'no specific instruction set' ELF e_machine value diffstat: point the license checksum at the license ruby: remove tcl DEPENDS waf: don't assume the waf intepretter is good Scott Murray (3): grub: fix "CVE:" line in one of the patches patch: fix CVE-2019-20633 glibc: CVE-2019-25013 Steve Sakoman (5): sqlite3: add CVE-2015-3717 to whitelist oeqa/selftest/cases/devtool.py: fix typo in ignore_patterns call cups: whitelist CVE-2018-6553 documentation: prepare for 3.1.5 release poky.conf: Bump version for 3.1.5 release Tanu Kaskinen (1): pulseaudio: Remove OE_LT_RPATH_ALLOW Thomas Perrot (1): go.bbclass: don't stage test data with sources of dependencies Tomasz Dziendzielski (2): populate_sdk_base: Fix condition syntax if SDK_RELOCATE_AFTER_INSTALL is disabled lib/oe/utils: Return empty string in parallel_make Vyacheslav Yurkov (1): license_image.bbclass: use canonical name for license files Wang Mingyu (1): mobile-broadband-provider-info: upgrade 20190618 ->20201225 Wonmin Jung (1): kernel: Set proper LD in KERNEL_KCONFIG_COMMAND sangeeta jain (1): meta/lib/oeqa/manual/oe-core.json: Update test_bitbake_devshell zangrc (2): wireless-regdb: upgrade 2020.04.29 -> 2020.11.20 bash: Rename patch name meta-openembedded: f2d02cb71e..5bba79488b: Armin Kuster (5): wireguard-module: fix build issue with 5.4 kernel mariadb: update to 10.4.17 for cve fixes lua: update to 5.3.6 nss: Security fix CVE-2020-12401 wireshark: Several securtiy fixes Chenxi Mao (1): geoclue: select avahi-daemon if nmea enabled Diego Santa Cruz (2): gssdp: Upgrade to 1.2.2 -> 1.2.3 gupnp: Upgrade to 1.2.2 -> 1.2.4 Gianfranco (1): dlt-daemon: add upstream patch to fix CVE-2020-29394 Khem Raj (4): nodejs: Fix build with icu 67.1 nodejs: Upgrade to 12.18.3 nodejs: Fix arm32/thumb builds with clang nodejs: Update to 12.19.0 Leon Anavi (1): php: Upgrade 7.4.4 -> 7.4.9 Max Kellermann (1): php: remove the failing ${D}/${TMPDIR} code Robert Joslyn (1): postgresql: Update to 12.5 Roland Hieber (1): pcsc-lite: provide pcsc-lite-lib-native explicitly for native build Sakib Sajal (1): apache2: upgrade v2.4.43 -> v2.4.46 Sean Nyekjaer (1): nodejs: 12.19.1 -> 12.20.1 Stacy Gaikovaia (1): nodejs: 12.19.0 -> 12.19.1 Wang Mingyu (1): zabbix: CVE-2020-15803 Security Advisory Wenlin Kang (2): lua: fix CVE-2020-15945 lua: fix CVE-2020-24371 Zang Ruochen (1): mcpp: Normalize the patch format of CVE Zheng Ruoqin (4): samba: CVE-2020-14318 Security Advisory samba: CVE-2020-14383 Security Advisory php: CVE-2020-7070 php: CVE-2020-7069 jabdoa2 (2): libsdl2-mixer: Fix ogg/vorbis support in libsdl2-mixer libsdl2-mixer: set --disable-music-ogg-shared to link statically viatsk (1): tcpdump: Patch for CVE-2020-8037 Signed-off-by: Patrick Williams <patrick@stwcx.xyz> Change-Id: I6e3b58075efc33fcfd6e9e1aa697f8763b5a89aa
Diffstat (limited to 'poky/documentation/README')
-rw-r--r--poky/documentation/README308
1 files changed, 271 insertions, 37 deletions
diff --git a/poky/documentation/README b/poky/documentation/README
index d64f2fd2f9..28d5c4be8e 100644
--- a/poky/documentation/README
+++ b/poky/documentation/README
@@ -34,22 +34,17 @@ Manual Organization
Folders exist for individual manuals as follows:
-* sdk-manual - The Yocto Project Software Development Kit (SDK) Developer's Guide.
-* bsp-guide - The Yocto Project Board Support Package (BSP) Developer's Guide
-* dev-manual - The Yocto Project Development Tasks Manual
-* kernel-dev - The Yocto Project Linux Kernel Development Tasks Manual
-* ref-manual - The Yocto Project Reference Manual
-* yocto-project-qs - The Yocto Project Quick Start
-* mega-manual - The Yocto Project Mega-Manual, which is an aggregated manual comprised
- of all YP manuals and guides
-* profile-manual - The Yocto Project Profile and Tracing Manual
-* toaster-manual - The Toaster Manual
-
-Each folder is self-contained regarding content and figures. Note that there
-is a sed file needed to process the links of the mega-manual. The sed file
-is located in the tools directory. Also note that the figures folder in the
-mega-manual directory contains duplicates of all the figures in the YP folders
-directories for all YP manuals and guides.
+* sdk-manual - The Yocto Project Software Development Kit (SDK) Developer's Guide.
+* bsp-guide - The Yocto Project Board Support Package (BSP) Developer's Guide
+* dev-manual - The Yocto Project Development Tasks Manual
+* kernel-dev - The Yocto Project Linux Kernel Development Tasks Manual
+* ref-manual - The Yocto Project Reference Manual
+* brief-yoctoprojectqs - The Yocto Project Quick Start
+* profile-manual - The Yocto Project Profile and Tracing Manual
+* toaster-manual - The Toaster Manual
+* test-manual - The Test Environment Manual
+
+Each folder is self-contained regarding content and figures.
If you want to find HTML versions of the Yocto Project manuals on the web,
go to http://www.yoctoproject.org and click on the "Documentation" tab. From
@@ -60,34 +55,273 @@ currently being developed.
In general, the Yocto Project site (http://www.yoctoproject.org) is a great
reference for both information and downloads.
-Makefile
+poky.yaml
+=========
+
+This file defines variables used for documentation production. The variables
+are used to define release pathnames, URLs for the published manuals, etc.
+
+template
========
+Contains various templates, fonts, and some old PNG files.
+
+Sphinx
+======
+
+The Yocto Project documentation was migrated from the original DocBook
+format to Sphinx based documentation for the Yocto Project 3.2
+release. This section will provide additional information related to
+the Sphinx migration, and guidelines for developers willing to
+contribute to the Yocto Project documentation.
+
+ Sphinx is a tool that makes it easy to create intelligent and
+ beautiful documentation, written by Georg Brandl and licensed under
+ the BSD license. It was originally created for the Python
+ documentation.
+
+Extensive documentation is available on the Sphinx website:
+https://www.sphinx-doc.org/en/master/. Sphinx is designed to be
+extensible thanks to the ability to write our own custom extensions,
+as Python modules, which will be executed during the generation of the
+documentation.
+
+Yocto Project documentation website
+===================================
+
+A new website has been created to host the Yocto Project
+documentation, it can be found at: https://docs.yoctoproject.org/.
+
+The entire Yocto Project documentation, as well as the BitBake manual
+is published on this website, including all previously released
+versions. A version switcher was added, as a drop-down menu on the top
+of the page to switch back and forth between the various versions of
+the current active Yocto Project releases.
+
+Transition pages have been added (as rst file) to show links to old
+versions of the Yocto Project documentation with links to each manual
+generated with DocBook.
+
+How to build the Yocto Project documentation
+============================================
+
+Sphinx is written in Python. While it might work with Python2, for
+obvious reasons, we will only support building the Yocto Project
+documentation with Python3.
+
+Sphinx might be available in your Linux distro packages repositories,
+however it is not recommend using distro packages, as they might be
+old versions, especially if you are using an LTS version of your
+distro. The recommended method to install Sphinx and all required
+dependencies is to use the Python Package Index (pip).
-The Makefile processes manual directories to create HTML, PDF,
-tarballs, etc. Details on how the Makefile work are documented
-inside the Makefile. See that file for more information.
+To install all required packages run:
-To build a manual, you run the make command and pass it the name
-of the folder containing the manual's contents.
-For example, the following command run from the documentation directory
-creates an HTML version of the SDK manual.
-The DOC variable specifies the manual you are making:
+ $ pip3 install sphinx sphinx_rtd_theme pyyaml
- $ make DOC=sdk-manual
+To build the documentation locally, run:
-poky.ent
+ $ cd documentation
+ $ make html
+
+The resulting HTML index page will be _build/html/index.html, and you
+can browse your own copy of the locally generated documentation with
+your browser.
+
+Alternatively, you can use Pipenv to automatically install all required
+dependencies in a virtual environment:
+
+ $ cd documentation
+ $ pipenv install
+ $ pipenv run make html
+
+Sphinx theme and CSS customization
+==================================
+
+The Yocto Project documentation is currently based on the "Read the
+Docs" Sphinx theme, with a few changes to make sure the look and feel
+of the project documentation is preserved.
+
+Most of the theme changes can be done using the file
+'sphinx-static/theme_overrides.css'. Most CSS changes in this file
+were inherited from the DocBook CSS stylesheets.
+
+Sphinx design guidelines and principles
+=======================================
+
+The initial Docbook to Sphinx migration was done with an automated
+tool called Pandoc (https://pandoc.org/). The tool produced some clean
+output markdown text files. After the initial automated conversion
+additional changes were done to fix up headings, images and links. In
+addition Sphinx has built in mechanisms (directives) which were used
+to replace similar functions implemented in Docbook such as glossary,
+variables substitutions, notes and references.
+
+Headings
========
-This file defines variables used for documentation production. The variables
-are used to define release pathnames, URLs for the published manuals, etc.
+The layout of the Yocto Project manuals is organized as follows
-template
+ Book
+ Chapter
+ Section
+ Section
+ Section
+
+The following headings styles are defined in Sphinx:
+
+ Book => overline ===
+ Chapter => overline ***
+ Section => ====
+ Section => ----
+ Section => ^^^^
+ Section => """" or ~~~~
+
+With this proposal, we preserve the same TOCs between Sphinx and Docbook.
+
+Built-in glossary
+=================
+
+Sphinx has a glossary directive. From
+https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#glossary:
+
+ This directive must contain a reST definition list with terms and
+ definitions. The definitions will then be referencable with the
+ [https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-term
+ 'term' role].
+
+So anywhere in any of the Yocto Project manuals, :term:`VAR` can be
+used to refer to an item from the glossary, and a link is created
+automatically. A general index of terms is also generated by Sphinx
+automatically.
+
+Global substitutions
+====================
+
+The Yocto Project documentation makes heavy use of global
+variables. In Docbook these variables are stored in the file
+poky.ent. This Docbook feature is not handled automatically with
+Pandoc. Sphinx has builtin support for substitutions
+(https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#substitutions),
+however there are important shortcomings. For example they cannot be
+used/nested inside code-block sections.
+
+A Sphinx extension was implemented to support variable substitutions
+to mimic the DocBook based documentation behavior. Variabes
+substitutions are done while reading/parsing the .rst files. The
+pattern for variables substitutions is the same as with DocBook,
+e.g. `&VAR;`.
+
+The implementation of the extension can be found here in the file
+documentation/sphinx/yocto-vars.py, this extension is enabled by
+default when building the Yocto Project documentation. All variables
+are set in a file call poky.yaml, which was initially generated from
+poky.ent. The file was converted into YAML so that it is easier to
+process by the custom Sphinx extension (which is a Python module).
+
+For example, the following .rst content will produce the 'expected'
+content:
+
+ .. code-block::
+ $ mkdir ~/poky-&DISTRO;
+ or
+ $ git clone &YOCTO_GIT_URL;/git/poky -b &DISTRO_NAME_NO_CAP;
+
+Variables can be nested, like it was the case for DocBook:
+
+ YOCTO_HOME_URL : "http://www.yoctoproject.org"
+ YOCTO_DOCS_URL : "&YOCTO_HOME_URL;/docs"
+
+Note directive
+==============
+
+Sphinx has a builtin 'note' directive that produces clean Note section
+in the output file. There are various types of directives such as
+"attention", "caution", "danger", "error", "hint", "important", "tip",
+"warning", "admonition" that are supported, and additional directive
+can be added as Sphinx extension if needed.
+
+Figures
+=======
+
+The Yocto Project documentation has many figures/images. Sphinx has a
+'figure' directive which is straight forward to use. To include a
+figure in the body of the documentation:
+
+ .. image:: figures/YP-flow-diagram.png
+
+Links and References
+====================
+
+The following types of links can be used: links to other locations in
+the same document, to locations in other documents and to external
+websites.
+
+More information can be found here:
+https://sublime-and-sphinx-guide.readthedocs.io/en/latest/references.html.
+
+References
+==========
+
+The following extension is enabed by default:
+sphinx.ext.autosectionlabel
+(https://www.sphinx-doc.org/en/master/usage/extensions/autosectionlabel.html).
+
+This extension allows you to refer sections by their titles. Note that
+autosectionlabel_prefix_document is enabled by default, so that we can
+insert references from any document.
+
+For example, to insert an HTML link to a section from
+documentaion/manual/intro.rst, use:
+
+ Please check this :ref:`manual/intro:Cross-References to Locations in the Same Document`
+
+Alternatively a custom text can be used instead of using the section
+text:
+
+ Please check this :ref:`section <manual/intro:Cross-References to Locations in the Same Document>`
+
+TIP: The following command can be used to dump all the references that
+ are defined in the project documentation:
+
+ python -msphinx.ext.intersphinx <path to build folder>/html/objects.inv
+
+This dump contains all links and for each link it shows the default
+"Link Text" that Sphinx would use. If the default link text is not
+appropriate, a custom link text can be used in the ':ref:' directive.
+
+Extlinks
========
-Contains various templates, fonts, and some old PNG files.
-tools
-=====
-Contains a tool to convert the DocBook files to PDF format. This folder also
-contains the mega-manual.sed file, which is used by Makefile to process
-cross-references from within the manual that normally go to an external
-manual.
+The sphinx.ext.extlinks extension is enabled by default
+(https://sublime-and-sphinx-guide.readthedocs.io/en/latest/references.html#use-the-external-links-extension),
+and it is configured with:
+
+ 'yocto_home': ('https://yoctoproject.org%s', None),
+ 'yocto_wiki': ('https://wiki.yoctoproject.org%s', None),
+ 'yocto_dl': ('https://downloads.yoctoproject.org%s', None),
+ 'yocto_lists': ('https://lists.yoctoproject.org%s', None),
+ 'yocto_bugs': ('https://bugzilla.yoctoproject.org%s', None),
+ 'yocto_ab': ('https://autobuilder.yoctoproject.org%s', None),
+ 'yocto_docs': ('https://docs.yoctoproject.org%s', None),
+ 'yocto_git': ('https://git.yoctoproject.org%s', None),
+ 'oe_home': ('https://www.openembedded.org%s', None),
+ 'oe_lists': ('https://lists.openembedded.org%s', None),
+
+It creates convenient shortcuts which can be used throughout the
+documentation rst files, as:
+
+ Please check this :yocto_wiki:`wiki page </Weekly_Status>`
+
+Intersphinx links
+=================
+
+The sphinx.ext.intersphinx extension is enabled by default
+(https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html),
+so that we can cross reference content from other Sphinx based
+documentation projects, such as the BitBake manual.
+
+References to the bitbake manual can be done like this:
+
+ See the ":ref:`-D <bitbake:bitbake-user-manual/bitbake-user-manual-intro:usage and syntax>`" option
+or
+ :term:`bitbake:BB_NUMBER_PARSE_THREADS`