Yocto Project 参考手册

目录

• 1 系统要求
  • 1.1 最低可用磁盘空间
  • 1.2 最低系统内存
  • 1.3 受支持的 Linux 发行版
  • 1.4 构建主机所需的软件包
    • 1.4.1 Ubuntu 和 Debian
    • 1.4.2 Fedora 软件包
    • 1.4.3 openSUSE Leap 软件包
      • 1.4.3.1 openSUSE Leap 15.6 软件包
      • 1.4.3.2 openSUSE Leap 16.0 软件包
    • 1.4.4 AlmaLinux 软件包
    • 1.4.5 CentOS Stream 软件包
    • 1.4.6 RockyLinux 软件包
  • 1.5 所需的 Git、tar、Python、make 和 gcc 版本
    • 1.5.1 使用 install-buildtools 脚本安装预构建的 buildtools 压缩包
    • 1.5.2 下载预构建的 buildtools 压缩包
    • 1.5.3 自行构建 buildtools 压缩包
• 2 Yocto Project 支持的架构和功能
  • 2.1 主要支持
  • 2.2 次要支持
  • 2.3 未测试
• 3 Yocto Project 术语
• 4 Yocto Project 版本与稳定版本发布流程
  • 4.1 主要版本与次要版本的发布节奏
  • 4.2 开发周期
  • 4.3 主要版本代号
  • 4.4 稳定版本流程
  • 4.5 稳定版本与 LTS 的补丁接收政策
  • 4.6 稳定点版本升级
    • 4.6.1 符合条件的上游项目标准
    • 4.6.2 稳定版本正则表达式的工作方式
  • 4.7 长期支持版本
  • 4.8 测试与质量保证
• 5 源码目录结构
  • 5.1 顶层核心组件
    • 5.1.1 bitbake/
    • 5.1.2 build/
    • 5.1.3 layers/yocto-docs/
    • 5.1.4 layers/openembedded-core/
      • 5.1.4.1 meta/
      • 5.1.4.2 meta-selftest/
      • 5.1.4.3 meta-skeleton/
      • 5.1.4.4 scripts/
      • 5.1.4.5 oe-init-build-env
    • 5.1.5 layers/meta-yocto/
      • 5.1.5.1 meta-poky/
      • 5.1.5.2 meta-yocto-bsp/
  • 5.2 构建目录 --- build/
    • 5.2.1 build/buildhistory/
    • 5.2.2 build/cache/
    • 5.2.3 build/conf/local.conf
    • 5.2.4 build/conf/bblayers.conf
    • 5.2.5 build/conf/site.conf
    • 5.2.6 build/conf/bblock.conf
    • 5.2.7 build/conf/toolcfg.conf
    • 5.2.8 build/conf/auto.conf
    • 5.2.9 build/downloads/
    • 5.2.10 build/sstate-cache/
    • 5.2.11 build/tmp/
      • 5.2.11.1 build/tmp/buildstats/
      • 5.2.11.2 build/tmp/cache/
      • 5.2.11.3 build/tmp/deploy/
        • 5.2.11.3.1 build/tmp/deploy/deb/
        • 5.2.11.3.2 build/tmp/deploy/rpm/
        • 5.2.11.3.3 build/tmp/deploy/ipk/
        • 5.2.11.3.4 build/tmp/deploy/licenses/
        • 5.2.11.3.5 build/tmp/deploy/spdx/
        • 5.2.11.3.6 build/tmp/deploy/images/
        • 5.2.11.3.7 build/tmp/deploy/sdk/
      • 5.2.11.4 build/tmp/hosttools/
      • 5.2.11.5 build/tmp/pkgdata/
      • 5.2.11.6 build/tmp/sstate-control/
      • 5.2.11.7 build/tmp/sysroots-components/
      • 5.2.11.8 build/tmp/sysroots/
      • 5.2.11.9 build/tmp/stamps/
      • 5.2.11.10 build/tmp/log/
      • 5.2.11.11 build/tmp/work/
        • 5.2.11.11.1 build/tmp/work/tunearch/recipename/version/
      • 5.2.11.12 build/tmp/work-shared/
  • 5.3 OpenEmbedded-Core（OE-Core）元数据 --- meta/
    • 5.3.1 meta/classes*/
    • 5.3.2 meta/conf/
      • 5.3.2.1 meta/conf/machine/
      • 5.3.2.2 meta/conf/distro/
      • 5.3.2.3 meta/conf/machine-sdk/
    • 5.3.3 meta/files/
    • 5.3.4 meta/lib/
    • 5.3.5 meta/recipes-bsp/
    • 5.3.6 meta/recipes-connectivity/
    • 5.3.7 meta/recipes-core/
    • 5.3.8 meta/recipes-devtools/
    • 5.3.9 meta/recipes-extended/
    • 5.3.10 meta/recipes-gnome/
    • 5.3.11 meta/recipes-graphics/
    • 5.3.12 meta/recipes-kernel/
    • 5.3.13 meta/recipes-multimedia/
    • 5.3.14 meta/recipes-rt/
    • 5.3.15 meta/recipes-sato/
    • 5.3.16 meta/recipes-support/
    • 5.3.17 meta/site/
    • 5.3.18 meta/recipes.txt
• 6 类
  • 6.1 allarch
  • 6.2 archiver
  • 6.3 autotools*
  • 6.4 barebox
  • 6.5 base
  • 6.6 bash-completion
  • 6.7 bin_package
  • 6.8 binconfig
  • 6.9 binconfig-disabled
  • 6.10 buildhistory
  • 6.11 buildstats
  • 6.12 buildstats-summary
  • 6.13 cargo
  • 6.14 cargo_c
  • 6.15 cargo_common
  • 6.16 cargo-update-recipe-crates
  • 6.17 ccache
  • 6.18 chrpath
  • 6.19 cmake
  • 6.20 cmake-qemu
  • 6.21 cml1
  • 6.22 compress_doc
  • 6.23 copyleft_compliance
  • 6.24 copyleft_filter
  • 6.25 core-image
  • 6.26 cpan*
  • 6.27 create-spdx
  • 6.28 cross
  • 6.29 cross-canadian
  • 6.30 crosssdk
  • 6.31 cython
  • 6.32 debian
  • 6.33 deploy
  • 6.34 devicetree
  • 6.35 devshell
  • 6.36 devupstream
  • 6.37 externalsrc
  • 6.38 extrausers
  • 6.39 features_check
  • 6.40 fontcache
  • 6.41 fs-uuid
  • 6.42 gconf
  • 6.43 gettext
  • 6.44 github-releases
  • 6.45 gnomebase
  • 6.46 go
  • 6.47 go-mod
  • 6.48 go-mod-update-modules
  • 6.49 go-vendor
  • 6.50 gobject-introspection
  • 6.51 grub-efi
  • 6.52 gsettings
  • 6.53 gtk-doc
  • 6.54 gtk-icon-cache
  • 6.55 gtk-immodules-cache
  • 6.56 gzipnative
  • 6.57 image
  • 6.58 image-buildinfo
  • 6.59 image_types
  • 6.60 image-container
  • 6.61 image-live
  • 6.62 insane
  • 6.63 kernel
  • 6.64 kernel-arch
  • 6.65 kernel-devicetree
  • 6.66 kernel-fit-image
  • 6.67 kernel-fit-extra-artifacts
  • 6.68 kernel-grub
  • 6.69 kernel-module-split
  • 6.70 kernel-uboot
  • 6.71 kernel-uimage
  • 6.72 kernel-yocto
  • 6.73 kernel-yocto-rust
  • 6.74 kernelsrc
  • 6.75 lib_package
  • 6.76 libc*
  • 6.77 license
  • 6.78 linuxloader
  • 6.79 logging
  • 6.80 meson
  • 6.81 metadata_scm
  • 6.82 mime
  • 6.83 mime-xdg
  • 6.84 mirrors
  • 6.85 module
  • 6.86 module-base
  • 6.87 module-rust
  • 6.88 multilib*
  • 6.89 native
  • 6.90 nativesdk
  • 6.91 nopackages
  • 6.92 nospdx
  • 6.93 npm
  • 6.94 overlayfs
  • 6.95 overlayfs-etc
  • 6.96 own-mirrors
  • 6.97 package
  • 6.98 package_deb
  • 6.99 package_ipk
  • 6.100 package_rpm
  • 6.101 packagedata
  • 6.102 packagegroup
  • 6.103 patch
  • 6.104 perlnative
  • 6.105 pypi
  • 6.106 python_flit_core
  • 6.107 python_maturin
  • 6.108 python_mesonpy
  • 6.109 python_pbr
  • 6.110 python_pdm
  • 6.111 python_pep517
  • 6.112 python_poetry_core
  • 6.113 python_pyo3
  • 6.114 python_uv_build
  • 6.115 python-setuptools3_rust
  • 6.116 pixbufcache
  • 6.117 pkgconfig
  • 6.118 populate_sdk
  • 6.119 populate_sdk_*
  • 6.120 prexport
  • 6.121 primport
  • 6.122 prserv
  • 6.123 ptest
  • 6.124 ptest-cargo
  • 6.125 ptest-gnome
  • 6.126 ptest-python-pytest
  • 6.127 python3-dir
  • 6.128 python3native
  • 6.129 python3targetconfig
  • 6.130 qemu
  • 6.131 recipe_sanity
  • 6.132 relative_symlinks
  • 6.133 relocatable
  • 6.134 remove-libtool
  • 6.135 report-error
  • 6.136 retain
  • 6.137 rm_work
  • 6.138 rootfs*
  • 6.139 rust
  • 6.140 rust-common
  • 6.141 rust-target-config
  • 6.142 sanity
  • 6.143 sbom-cve-check
  • 6.144 sbom-cve-check-recipe
  • 6.145 scons
  • 6.146 sdl
  • 6.147 python_setuptools_build_meta
  • 6.148 setuptools3
  • 6.149 setuptools3_legacy
  • 6.150 setuptools3-base
  • 6.151 sign_rpm
  • 6.152 siteinfo
  • 6.153 sstate
  • 6.154 staging
  • 6.155 syslinux
  • 6.156 systemd
  • 6.157 systemd-boot
  • 6.158 terminal
  • 6.159 testexport
  • 6.160 testimage
  • 6.161 testsdk
  • 6.162 texinfo
  • 6.163 toaster
  • 6.164 toolchain-scripts
  • 6.165 toolchain/clang
  • 6.166 toolchain/clang-native
  • 6.167 toolchain/gcc
  • 6.168 toolchain/gcc-native
  • 6.169 typecheck
  • 6.170 uboot-config
  • 6.171 uboot-extlinux-config
  • 6.172 uboot-sign
  • 6.173 uki
  • 6.174 uninative
  • 6.175 update-alternatives
  • 6.176 update-rc.d
  • 6.177 upstream-stable-release-point
  • 6.178 useradd*
  • 6.179 utility-tasks
  • 6.180 utils
  • 6.181 vala
  • 6.182 vex
  • 6.183 waf
  • 6.184 yocto-check-layer
• 7 任务
  • 7.1 常规配方构建任务
    • 7.1.1 do_build
    • 7.1.2 do_compile
    • 7.1.3 do_compile_ptest_base
    • 7.1.4 do_configure
    • 7.1.5 do_configure_ptest_base
    • 7.1.6 do_deploy
    • 7.1.7 do_fetch
    • 7.1.8 do_image
    • 7.1.9 do_image_complete
    • 7.1.10 do_install
    • 7.1.11 do_install_ptest_base
    • 7.1.12 do_package
    • 7.1.13 do_package_qa
    • 7.1.14 do_package_write_deb
    • 7.1.15 do_package_write_ipk
    • 7.1.16 do_package_write_rpm
    • 7.1.17 do_packagedata
    • 7.1.18 do_patch
    • 7.1.19 do_populate_lic
    • 7.1.20 do_populate_sdk
    • 7.1.21 do_populate_sdk_ext
    • 7.1.22 do_populate_sysroot
    • 7.1.23 do_prepare_recipe_sysroot
    • 7.1.24 do_recipe_qa
    • 7.1.25 do_rm_work
    • 7.1.26 do_unpack
  • 7.2 手动调用的任务
    • 7.2.1 do_checkuri
    • 7.2.2 do_clean
    • 7.2.3 do_cleanall
    • 7.2.4 do_cleansstate
    • 7.2.5 do_pydevshell
    • 7.2.6 do_devshell
    • 7.2.7 do_list_image_features
    • 7.2.8 do_listtasks
    • 7.2.9 do_package_index
  • 7.3 镜像相关任务
    • 7.3.1 do_bootimg
    • 7.3.2 do_bundle_initramfs
    • 7.3.3 do_rootfs
    • 7.3.4 do_testimage
    • 7.3.5 do_testimage_auto
  • 7.4 内核相关任务
    • 7.4.1 do_compile_kernelmodules
    • 7.4.2 do_diffconfig
    • 7.4.3 do_kernel_checkout
    • 7.4.4 do_kernel_configcheck
    • 7.4.5 do_kernel_configme
    • 7.4.6 do_kernel_metadata
    • 7.4.7 do_menuconfig
    • 7.4.8 do_savedefconfig
    • 7.4.9 do_shared_workdir
    • 7.4.10 do_sizecheck
    • 7.4.11 do_strip
    • 7.4.12 do_validate_branches
• 8 使用配置片段
  • 8.1 bitbake-config-build 速查
    • 8.1.1 bitbake-config-build list-fragments
    • 8.1.2 bitbake-config-build show-fragment
    • 8.1.3 bitbake-config-build enable-fragment
    • 8.1.4 bitbake-config-build disable-fragment
    • 8.1.5 bitbake-config-build disable-all-fragments
  • 8.2 核心片段
    • 8.2.1 核心内置片段
      • 8.2.1.1 machine/
      • 8.2.1.2 distro/
    • 8.2.2 核心配置片段
      • 8.2.2.1 Yocto Project 片段
        • 8.2.2.1.1 core/yocto/sstate-mirror-cdn
        • 8.2.2.1.2 core/yocto/root-login-with-empty-password
        • 8.2.2.1.3 core/yocto/sbom-cve-check
        • 8.2.2.1.4 core/yocto/monitor-disk-space
      • 8.2.2.2 Yocto Project Autobuilder 片段
        • 8.2.2.2.1 core/yocto-autobuilder/autobuilder
        • 8.2.2.2.2 core/yocto-autobuilder/autobuilder-resource-constraints
        • 8.2.2.2.3 core/yocto-autobuilder/multilib-mips64-n32
        • 8.2.2.2.4 core/yocto-autobuilder/multilib-x86-lib32
        • 8.2.2.2.5 core/yocto-autobuilder/multilib-x86-lib64
• 9 devtool 速查
  • 9.1 获取帮助
  • 9.2 工作区层结构
  • 9.3 向工作区层添加新配方
  • 9.4 提取现有配方的源码
  • 9.5 同步已提取的配方源码树
  • 9.6 修改现有配方
  • 9.7 编辑现有配方
  • 9.8 更新配方
  • 9.9 检查配方的升级状态
  • 9.10 升级配方
  • 9.11 重置配方
  • 9.12 完成配方工作
  • 9.13 构建配方
  • 9.14 构建镜像
  • 9.15 在目标机器上部署软件
  • 9.16 从目标机器移除软件
  • 9.17 在其他位置创建工作区层
  • 9.18 获取工作区配方状态
  • 9.19 搜索可用的目标配方
  • 9.20 获取配方配置脚本信息
  • 9.21 为配方生成 IDE 配置
• 10 OpenEmbedded Kickstart（.wks）参考
  • 10.1 简介
  • 10.2 命令：part 或 partition
  • 10.3 命令：bootloader
  • 10.4 指令：include
• 11 质量检查错误和警告消息
  • 11.1 简介
  • 11.2 错误和警告
    • 11.2.1 already-stripped
    • 11.2.2 arch
    • 11.2.3 build-deps
    • 11.2.4 buildpaths
    • 11.2.5 configure-gettext
    • 11.2.6 configure-unsafe
    • 11.2.7 debug-deps
    • 11.2.8 debug-files
    • 11.2.9 dep-cmp
    • 11.2.10 dev-deps
    • 11.2.11 desktop
    • 11.2.12 dev-so
    • 11.2.13 empty-dirs
    • 11.2.14 file-rdeps
    • 11.2.15 files-invalid
    • 11.2.16 host-user-contaminated
    • 11.2.17 infodir
    • 11.2.18 installed-vs-shipped
    • 11.2.19 incompatible-license
    • 11.2.20 invalid-chars
    • 11.2.21 invalid-packageconfig
    • 11.2.22 la
    • 11.2.23 ldflags
    • 11.2.24 libdir
    • 11.2.25 libexec
    • 11.2.26 mime
    • 11.2.27 mime-xdg
    • 11.2.28 missing-update-alternatives
    • 11.2.29 packages-list
    • 11.2.30 patch-fuzz
    • 11.2.31 patch-status
    • 11.2.32 pep517-backend
    • 11.2.33 perllocalpod
    • 11.2.34 perm-config
    • 11.2.35 perm-line
    • 11.2.36 perm-link
    • 11.2.37 perms
    • 11.2.38 pkgconfig
    • 11.2.39 pkgname
    • 11.2.40 pkgvarcheck
    • 11.2.41 pn-overrides
    • 11.2.42 shebang-size
    • 11.2.43 共享库提供者
    • 11.2.44 space-around-equal
    • 11.2.45 src-uri-bad
    • 11.2.46 staticdev
    • 11.2.47 symlink-to-sysroot
    • 11.2.48 配方命名
    • 11.2.49 rpaths
    • 11.2.50 textrel
    • 11.2.51 unhandled-features-check
    • 11.2.52 unimplemented-ptest
    • 11.2.53 unknown-configure-option
    • 11.2.54 unlisted-pkg-lics
    • 11.2.55 useless-rpaths
    • 11.2.56 usrmerge
    • 11.2.57 version-going-backwards
    • 11.2.58 virtual-slash
    • 11.2.59 xorg-driver-abi
  • 11.3 配置和禁用质量检查
• 12 镜像
• 13 功能
  • 13.1 机器功能
  • 13.2 发行版功能
  • 13.3 镜像功能
  • 13.4 SDK 功能
  • 13.5 默认功能
• 14 变量表
• 15 变量的使用上下文
  • 15.1 配置
    • 15.1.1 发行版（Distro）
    • 15.1.2 机器
    • 15.1.3 本地
  • 15.2 配方
    • 15.2.1 必需变量
    • 15.2.2 依赖关系
    • 15.2.3 路径
    • 15.2.4 额外构建信息
• 16 常见问题
  • 16.1 一般问题
    • 16.1.1 Poky 与 OpenEmbedded 有何不同？
    • 16.1.2 为何认为 Poky / OpenEmbedded-Core 是稳定的？
    • 16.1.3 是否有使用 OpenEmbedded 构建系统开发的产品？
    • 16.1.4 为什么 systemd 不是 Poky 发行版的默认初始化系统？
  • 16.2 构建环境
    • 16.2.1 开发系统缺少依赖怎么办？
    • 16.2.2 OpenEmbedded 如何获取源码？能否通过防火墙或代理服务器工作？
  • 16.3 使用 OpenEmbedded 构建系统
    • 16.3.1 如何使用外部工具链？
    • 16.3.2 为什么出现 chmod 权限问题？
    • 16.3.3 下载源码时出现很多 404 错误，是否有问题？
    • 16.3.4 为什么构建会随机失败？
    • 16.3.5 为什么构建因 iconv.h 问题失败？
    • 16.3.6 为什么其他配方找不到 *-native 配方提供的文件？
    • 16.3.7 能否删除构建输出，从头开始？
    • 16.3.8 为什么不能像对配方使用 bbappend 那样追加 bbclass 文件？
    • 16.3.9 如何集成第三方漏洞扫描工具？
  • 16.4 定制生成的镜像
    • 16.4.1 OpenEmbedded 构建系统会输出什么？
    • 16.4.2 如何让 Yocto Project 支持我的开发板？
    • 16.4.3 如何让 Yocto Project 支持我的软件包？
    • 16.4.4 为了遵守许可证，需要随产品提供哪些内容？
    • 16.4.5 重新编译一个软件包后，是否必须完整重新烧写？
    • 16.4.6 如何防止软件包被标记为机器专用？
    • 16.4.7 target 与 target-native 有什么区别？
    • 16.4.8 为什么 -native 配方的 ${bindir} 和 ${libdir} 值很奇怪？
    • 16.4.9 如何创建具有更多可用空间的镜像？
    • 16.4.10 为什么不支持路径名中的空格？
    • 16.4.11 我在配方中添加了二进制文件，为什么镜像里的文件不同？
  • 16.5 运行系统中的问题
    • 16.5.1 如何禁用触摸屏设备上的光标？
    • 16.5.2 如何始终启用已连接的网络接口？
• 17 贡献与其他信息
  • 17.1 简介
  • 17.2 贡献
  • 17.3 Yocto Project Bugzilla
  • 17.4 邮件列表
  • 17.5 互联网中继聊天（IRC）
  • 17.6 链接与相关文档

---

Yocto 项目中文文档

<docs@lists.yoctoproject.org>

允许按照 Creative Commons 发布的 知识共享署名—相同方式共享 2.0 英国：英格兰及威尔士许可 条款复制、分发和／或修改本文档。

如发现本手册或其他 Yocto 项目手册存在不准确之处或问题，或希望提交补充和修改， 请向 Yocto 项目文档邮件列表 docs@lists.yoctoproject.org 发送邮件或补丁， 也可以加入 Libera Chat 的 #yocto 频道。