[Topic discussion] 玲珑系列文章——构建工具

Linyaps 1081 views · 3 replies ·

流浪的加菲

deepin

2024-03-07 14:43

Author

玲珑构建工具ll-builder简介

ll-builder是为应用开发者提供的一款构建玲珑应用工具。

主要功能如下：

支持在独立容器内构建。
提供 sdk 开发套件列表。

查看 ll-builder命令的帮助信息：

ll-builder --help

ll-builder 命令的帮助信息如下：

Usage: ll-builder [options] subcommand [sub-option]

Options:
  -v, --verbose  show detail log
  -h, --help     Displays help on commandline options.
  --help-all     Displays help including Qt specific options.

Arguments:
  subcommand     create
                 build
                 run
                 export
                 push

创建项目

ll-builder create命令用来创建玲珑项目。

查看 ll-builder create命令的帮助信息：

ll-builder create --help

ll-builder create命令的帮助信息如下：

Usage: ll-builder [options] create 

Options:
  -v, --verbose  show detail log
  -h, --help     Displays help on commandline options.
  --help-all     Displays help including Qt specific options.

Arguments:
  create         create build template project
  name           project name

ll-builder create命令根据输入的项目名称在当前目录创建对应的文件夹，同时生成构建所需的 linglong.yaml模板文件。示例如下：

ll-builder create

ll-builder create org.deepin.demo命令输出如下：

org.deepin.demo/
└── linglong.yaml

编辑linglong.yaml

软件包元信息配置

package:
  id: org.deepin.demo
  name: deepin-demo
  version: 0.0.1
  kind: app
  description: |
    simple Qt demo.

运行时

runtime:
  id: org.deepin.Runtime
  version: 23.0.0

依赖项

depends:
  - id: icu
    version: 63.1.0
    type: runtime

源码

使用git源码

source:
  kind: git
  url: "https://github.com/linuxdeepin/linglong-builder-demo.git"
  commit: 24f78c8463d87ba12b0ac393ec56218240315a9

选择构建模板

源码为qmake工程，填写build 类型为qmake（模板内容见qmake.yaml）。

build:
  kind: qmake

完整的linglong.yaml配置

linglong.yaml文件内容如下：

package:
  id: org.deepin.demo
  name: deepin-demo
  version: 0.0.1
  kind: app
  description: |
    simple Qt demo.

runtime:
  id: org.deepin.Runtime
  version: 23.0.0

depends:
  - id: icu
    version: 63.1.0
    type: runtime

source:
  kind: git
  url: "https://github.com/linuxdeepin/linglong-builder-demo.git"
  commit: a3b89c3aa34c1aff8d7f823f0f4a87d5da8d4dc0

build:
  kind: qmake

构建应用

ll-builder build命令用来构建玲珑应用。

查看 ll-builder build命令的帮助信息：

ll-builder build --help

ll-builder build命令的帮助信息如下：

Usage: ll-builder [options] build

Options:
  -v, --verbose  show detail log
  -h, --help     Displays help on commandline options.
  --help-all     Displays help including Qt specific options.
  --exec   run exec than build script

Arguments:
  build          build project

ll-builder build命令必须运行在工程的根目录，即 linglong.yaml文件所在位置。

以玲珑项目 org.deepin.demo为例，构建玲珑应用主要步骤如下：

进入到 org.deepin.demo项目工程目录：

cd org.deepin.demo

执行 ll-builder build命令将开始构建玲珑应用:

ll-builder build

构建完成后，构建内容将自动提交到本地 ostree缓存中。导出构建内容见 ll-builder export。

使用 --exec参数可在构建脚本执行前进入玲珑容器：

ll-builder build --exec /bin/bash

进入容器后，可执行 shell命令，如 gdb、strace 等。

玲珑应用 debug版本更多调试信息请参考：DEBUG。

运行编译后的应用

ll-builder run命令可以运行编译后的可执行程序。

查看 ll-builder run命令的帮助信息：

ll-builder run --help

ll-builder run命令的帮助信息如下：

Usage: ll-builder [options] run

Options:
  -v, --verbose  show detail log
  -h, --help     Displays this help.
  --exec   run exec than build script

Arguments:
  run            run project

ll-builder run命令根据配置文件读取该程序相关的运行环境信息，构造一个容器环境，并在容器中执行该程序而无需安装。

ll-builder run

ll-builder run运行成功输出如下：

为了便于调试，使用额外的 --exec /bin/bash参数可替换进入容器后默认执行的程序，如：

ll-builder run --exec /bin/bash

使用该选项，ll-builder创建容器后将进入 bash终端，可在容器内执行其他操作。

构建配置文件简介

linglong.yaml 是玲珑项目工程的描述文件，记录构建所需的相关信息。如构建产物的名称、版本、源码地址、构建依赖等。

工程目录结构

{project-root}
├── linglong.yaml
└── .linglong-target

{user-home}
└── .cache
    └── linglong-builder
        ├── repo
        └── layers

字段定义

软件包元信息配置

package:
  id: org.deepin.calculator
  name: deepin-calculator
  version: 5.7.21
  kind: app
  description: |
    calculator for deepin os.

name	description
description	构建产物的详细描述
id	构建产物的唯一名称
kind	构建产物的类型：app、runtime、lib，依次代表应用、运行时、库
version	构建产物的版本

运行时（runtime）

应用运行时依赖，同时也是构建依赖。

runtime:
  id: org.deepin.Runtime
  version: 23.0.0
  # NOT IMPLEMENTATION NOW
  digest: 4d85525f09211381c77d2085c9c1057

可简写为以下形式:

runtime:
  id: org.deepin.Runtime/23.0.0

name	description
id	运行时（runtime）的唯一名称
version	运行时（runtime）版本
digest	（暂未使用, 该字段可用来绑定唯一版本的运行时）

依赖项

描述应用的构建依赖与运行依赖。

depends:
  - id: dde-qt-dbus-factory
    version: 5.5.12
  - id: googletest
    version: 1.8.1
  - id: icu
    version: 63.1.0
    type: runtime
  - id: xcb-util
    version: 0.3.8.1
    type: runtime

name	description
id	依赖的唯一名称
type	依赖的类型，类型为 runtime 的依赖，将会和构建内容一起被提交;未设置type时, 该依赖仅参与构建
version	依赖的版本
digest	（暂未使用，该字段可用来绑定唯一版本的依赖）

ll-builder在项目构建时将从远程存储库拉取dpends下包含的依赖到本地。若远程存储库不存在该依赖或其无法满足要求,
可新增source与build内容, ll-builder将优先构建包含source与build类型的依赖并应用到项目构建中。

depends: 
  - id: icu
    version: 63.1.0
    source:
      kind: git
      url: https://github.com/deepin-community/icu.git
      version: master
      commit: 3c651bcc40748fc5d02d9134fcaee14fda44ab62
    build:
      kind: autotools

源码

描述源码信息。

source:
  kind: git
  url: https://github.com/linuxdeepin/deepin-calculator.git
  version: master
  commit: d7e207b4a71bbd97f7d818de5044228c1a6e2c92
  patch: 
    - patches/fix-install-prefix-path.patch
    - patches/fix-lib-install-path.patch

name	description
kind	源码类型，可选类型 local、archive、git
url	源码地址，类型为 archive、git 时填写
version	源码分支版本，类型为 git 时填写
digest	归档文件的hash值，使用sha256算法加密，类型为archive时填写
commit	源码某次提交 hash 值，类型为 git 时填写
patch	源码补丁路径

构建规则

描述构建规则。

build:
  kind: manual
  manual:
    configure: |
      mkdir build
      cd build
      qmake -r PREFIX=${PREFIX} ..
    build: |
      make -j
      make test
    install: |
      make -j install

build:
  kind: autotools
  manual: 
    configure: |
      ./bootstrap.sh

name	description
build	构建时build规则
configure	构建时configure规则
install	构建时install规则
kind	构建类型，可选类型 manual、autotools、cmake、qmake
manual	构建规则，声明使用 manual 时，表示自定义规则，即对build、install、configure 重写

变量

描述构建可以使用的变量，配合build构建使用。

variables:
  build_dir: |
  dest_dir: |
  conf_args: |
    --prefix=${PREFIX}
    --libdir=lib/${TRIPLET}
  extra_args: |
    --doc=enable
  jobs: |
    -j64

build:
  kind: manual
  manual:
    configure: |
      ./configure ${conf_args} ${extra_args}
    build: |
      make ${jobs}
    install: |
      make DESTDIR=${dest_dir} install

name	description
build_dir	内置变量之一，variables字段下自定义赋值，build字段下使用
dest_dir	同build_dir
conf_args	同build_dir
extra_args	同build_dir
jobs	同build_dir
PREFIX	环境变量之一，可在variable、build字段下使用；提供构建时的安装路径
TRIPLET	环境变量之一，可在variable、build字段下使用；提供包含架构信息的三元组，如x86_64-linux-gnu

完整示例

构建应用

package:
  id: org.deepin.calculator
  name: deepin-calculator
  version: 5.7.21
  kind: app
  description: |
    calculator for deepin os.

runtime:
  id: org.deepin.Runtime
  version: 23.0.0

depends:
  - id: dde-qt-dbus-factory
    version: 5.5.12
  - id: googletest
    version: 1.8.1
  - id: icu
    version: 63.1.0
    type: runtime
  - id: xcb-util
    version: 0.3.8.1
    type: runtime

source:
  kind: git
  url: https://github.com/linuxdeepin/deepin-calculator.git
  version: master
  commit: d7e207b4a71bbd97f7d818de5044228c1a6e2c92

variables:
  extra_args: |
    -DCMAKE_BUILD_TYPE=Release \
    -DCMAKE_SAFETYTEST_ARG="CMAKE_SAFETYTEST_ARG_OFF" \
    -DAPP_VERSION=5.7.21 \
    -DVERSION=5.7.21

build:
  kind: cmake

构建依赖库

package:
  id: libopenjp2
  kind: lib
  version: 2.4.0

base:
  id: org.deepin.base
  version: 23.0.0

source:
  kind: git
  url: https://github.com/uclouvain/openjpeg
  version: 2.4.0
  commit: 37ac30ceff6640bbab502388c5e0fa0bff23f505

build:
  kind: cmake

构建运行时

package:
  id: org.deepin.Runtime
  kind: runtime
  version: 23.0.0
  description: |
    runtime of deepin

base:
  id: org.deepin.base/23.0.0

depends:
  - id: qtbase/5.15.7
  - id: qttranslations/5.15.7
  - id: qt3d/5.15.7
  - id: qtcharts/5.15.7
  - id: qtconnectivity/5.15.7
  - id: qtgamepad/5.15.7
  - id: qtsensors/5.15.7
  - id: qtspeech/5.15.7
  - id: qtvirtualkeyboard/5.15.7
  - id: qtserialport/5.15.7
  - id: qtnetworkauth/5.15.7
  - id: qttools/5.15.7
  - id: qtx11extras/5.15.7
  - id: qtdeclarative/5.15.7
  - id: qtsvg/5.15.7
  - id: qtscript/5.15.7
  - id: qtgraphicaleffects/5.15.7
  - id: qtquickcontrols/5.15.7
  - id: qtquickcontrols2/5.15.7
  - id: qtxmlpatterns/5.15.7
  - id: qtwayland/5.15.7
  - id: qtmultimedia/5.15.7
  - id: qtwebchannel/5.15.7
  - id: qtwebsockets/5.15.7
  - id: qtimageformats/5.15.7
  - id: qtlocation/5.15.7
  - id: spdlog/1.10.0
  - id: fmtlib/10.1.2
  - id: dtkcommon/5.6.0.3
  - id: dtkcore/5.6.0.9
  - id: dtkgui/5.6.0.13
  - id: dtkwidget/5.6.0.6
  - id: dtkdeclarative/5.6.0.7
  - id: qt5integration/5.6.0.5
  - id: qt5platform-plugins/5.6.0.5
  - id: libqtxdg/3.6.0.1
  - id: double-conversion/3.1.0.3
  - id: deepin-shortcut-viewer/5.0.6.1
  - id: fcitx-qt5/1.2.6.6
  - id: gsettings-qt/0.3.1.1
  - id: linglong-config/0.0.1.2

build:
  kind: manual
  manual:
    configure: |
      echo skip configure

package 类型为runtime时，将提交所有依赖内容。

构建工具模板

automake类型构建模板

autotools.yaml 提供了通用的 automake 类型构建模板, 模板文件如下:

variables:
  build_dir: build_dir
  conf_args: |
    --prefix=${PREFIX} \
    --libdir=${PREFIX}/lib/${TRIPLET}
  extra_args: |
  dest_dir: |
  jobs: -j${JOBS}

build:
  kind: autotools
  manual:
    configure: |
      #autogon.sh, bootstrap.sh
      autoreconf -ivf
      ./configure ${conf_args} ${extra_args}
    build: |
      make ${jobs}
    install: |
      make ${jobs} DESTDIR=${dest_dir} install

使用方法：

build:
  kind: autotools

qmake构建模板

qmake.yaml 提供了通用的 qmake 构建模板, 模板文件如下:

variables:
  build_dir: build_dir
  conf_args: |
    PREFIX=${PREFIX} \
    LIB_INSTALL_DIR=${PREFIX}/lib/${TRIPLET}
  extra_args: |
  dest_dir: |
  jobs: -j${JOBS}

build:
  kind: qmake
  manual :
    configure: |
      qmake -makefile ${conf_args} ${extra_args}
    build: |
      make ${jobs}
    install: |
      make ${jobs} DESTDIR=${dest_dir} install

使用方法：

build:
  kind: qmake

cmake构建模板

cmake.yaml 提供了通用的 cmake 构建模板, 模板文件如下:

variables:
  build_dir: build_dir
  conf_args: |
    -DCMAKE_INSTALL_PREFIX=${PREFIX} \
    -DCMAKE_INSTALL_LIBDIR=${PREFIX}/lib/${TRIPLET}
  extra_args: |
  dest_dir: |
  jobs: -j${JOBS}

build:
  kind: cmake
  manual :
    configure: |
      cmake -B ${build_dir} ${conf_args} ${extra_args}
    build: |
      cmake --build ${build_dir} -- ${jobs}
    install: |
      env DESTDIR=${dest_dir} cmake --build ${build_dir} --target install

使用方法：

build:
  kind: cmake

runtime 23.0.0 包含依赖项

id	version
qtbase	5.15.7
qt3d	5.15.7
qtcharts	5.15.7
qtconnectivity	5.15.7
qtgamepad	5.15.7
qtsensors	5.15.7
qtspeech	5.15.7
qtvirtualkeyboard	5.15.7
qtserialport	5.15.7
qtnetworkauth	5.15.7
qttools	5.15.7
qtx11extras	5.15.7
qtdeclarative	5.15.7
qtsvg	5.15.7
qtscript	5.15.7
qtgraphicaleffects	5.15.7
qtquickcontrols	5.15.7
qtquickcontrols2	5.15.7
qtxmlpatterns	5.15.7
qtwayland	5.15.7
qtmultimedia	5.15.7
qtwebchannel	5.15.7
qtwebsockets	5.15.7
qtimageformats	5.15.7
qtlocation	5.15.7
dtkcommon	5.6.0.3
dtkcore	5.6.0.9
dtkgui	5.6.0.13
dtkwidget	5.6.0.6
dtkdeclarative	5.6.0.7
libqtxdg	3.6.0.3
qt5integration	5.6.0.5
double-conversion	3.1.0.2
deepin-shortcut-viewer	5.0.6.1
fcitx-qt5	1.2.6.6
gsettings-qt	0.3.1.1
qt5platform-plugins	5.6.0.5
spdlog	1.10.0
fmtlib	10.1.2

其他可用依赖

id	version
aria2	1.34.0
bzip2	1.0.6
cdparanoia	3.10.2
dde-control-center	5.5.23
dde-dock	5.5.15
disomaster	5.0.7
djvulibre	3.5.27.1
ffmpeg	4.1.8
ffmpegthumbnailer	2.1.1
freeimage	3.18.0
gio-qt	0.0.11
gst-plugins-good1.0	1.14.5
gstreamer1.0	1.14.6
ilmbase	2.2.1
image-editor	1.0.9
jxrlib	1.1.1
karchive	5.54.0
kcodecs	5.54.0
kconfig	5.54.0
kcoreaddons	5.54.0
kcrash	5.54.0
kdbusaddons	5.54.0
kglobalaccel	5.54.0
ki18n	5.54.0
kservice	5.54.0
ksyntax-highlighting	5.54.0
kwayland	5.57.0
kwindowsystem	5.54.0
leveldb	1.20
libarchive	3.3.3
libchardet	1.0.4
libdbusmenu-qt	0.9.3
libdmr	5.9.13
libdv	1.0.0
libepoxy	1.5.3
libevent	2.1.8
libraw	0.19.2
libvisual	0.4.0
libxrandr	1.5.1
libxtst	5.5.15
libzip	1.5.1.8
minizip	1.1.1
mpv	0.29.1.37
opencv	3.2.0
openexr	2.2.1.4
procps	3.3.15
qtdbusextended	0.0.3
qtmpris	0.1.0.1
sqlite3	3.27.2.3
taglib	1.11.1
uchardet	0.0.6
udisks2-qt5	5.0.3
vlc	3.0.11
xcb-util	0.3.8.1
icu	63.1
dde-qt-dbus-factory	5.5.12
gst-plugins-base1.0	1.14.4.2
libdvdnav	6.0.0
libdvdread	6.0.0
libical3	3.0.4
libva	2.4.0
libxcursor	1.1.15
orc	0.4.28
poppler	0.71.0.2
kmod	26.1
pciutils	3.5.2.4
xz-utils	5.2.4.1
libxslt	1.1.32.3
v4l-utils	1.20.0
portaudio19	19.6.0
gst-plugins-bad1.0	1.14.4.2
gst-plugins-ugly1.0	1.14.4.2
nettle	3.4.1.2
aom	1.0.0.1
codec2	0.8.1
libdc1394	2.2.5
libmysofa	0.6
x264	0.155.2917
x265	2.9
xavs2	1.4.1
cunit	2.1
lapack	3.8.0.1
openblas	0.3.5
crystalhd	0.0.1
davs2	1.7.1
elfutils	0.176.2