summaryrefslogtreecommitdiff
path: root/poky/documentation/conf.py
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/conf.py
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/conf.py')
-rw-r--r--poky/documentation/conf.py131
1 files changed, 131 insertions, 0 deletions
diff --git a/poky/documentation/conf.py b/poky/documentation/conf.py
new file mode 100644
index 0000000000..518ebb480c
--- /dev/null
+++ b/poky/documentation/conf.py
@@ -0,0 +1,131 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# SPDX-License-Identifier: CC-BY-SA-2.0-UK
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+import datetime
+
+current_version = "3.1.5"
+
+# String used in sidebar
+version = 'Version: ' + current_version
+if current_version == 'dev':
+ version = 'Version: Current Development'
+# Version seen in documentation_options.js and hence in js switchers code
+release = current_version
+
+
+# -- Project information -----------------------------------------------------
+project = 'The Yocto Project \xae'
+copyright = '2010-%s, The Linux Foundation' % datetime.datetime.now().year
+author = 'The Linux Foundation'
+
+# -- General configuration ---------------------------------------------------
+
+# to load local extension from the folder 'sphinx'
+sys.path.insert(0, os.path.abspath('sphinx'))
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+ 'sphinx.ext.autosectionlabel',
+ 'sphinx.ext.extlinks',
+ 'sphinx.ext.intersphinx',
+ 'yocto-vars'
+]
+autosectionlabel_prefix_document = True
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'boilerplate.rst']
+
+# master document name. The default changed from contents to index. so better
+# set it ourselves.
+master_doc = 'index'
+
+# create substitution for project configuration variables
+rst_prolog = """
+.. |project_name| replace:: %s
+.. |copyright| replace:: %s
+.. |author| replace:: %s
+""" % (project, copyright, author)
+
+# external links and substitutions
+extlinks = {
+ '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),
+}
+
+# Intersphinx config to use cross reference with Bitbake user manual
+intersphinx_mapping = {
+ 'bitbake': ('https://docs.yoctoproject.org/bitbake/1.46', None)
+}
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. See the documentation for
+# a list of builtin themes.
+#
+try:
+ import sphinx_rtd_theme
+ html_theme = 'sphinx_rtd_theme'
+ html_theme_options = {
+ 'sticky_navigation': False,
+ }
+except ImportError:
+ sys.stderr.write("The Sphinx sphinx_rtd_theme HTML theme was not found.\
+ \nPlease make sure to install the sphinx_rtd_theme python package.\n")
+ sys.exit(1)
+
+html_logo = 'sphinx-static/YoctoProject_Logo_RGB.jpg'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['sphinx-static']
+
+html_context = {
+ 'current_version': current_version,
+}
+
+# Add customm CSS and JS files
+html_css_files = ['theme_overrides.css']
+html_js_files = ['switchers.js']
+
+# Hide 'Created using Sphinx' text
+html_show_sphinx = False
+
+# Add 'Last updated' on each page
+html_last_updated_fmt = '%b %d, %Y'
+
+# Remove the trailing 'dot' in section numbers
+html_secnumber_suffix = " "
+
+latex_elements = {
+ 'passoptionstopackages': '\PassOptionsToPackage{bookmarksdepth=5}{hyperref}',
+ 'preamble': '\setcounter{tocdepth}{2}',
+}