Emacs 构建脚本技术文档

2024-12-26 08:29:59作者：蔡丛锟

本文档将为您提供详细的指南，帮助您使用 Emacs 构建脚本，包括安装、使用说明以及 API 使用文档。

1. 安装指南

硬件要求

脚本模块化设计，可在多台构建机器（或虚拟机）上运行，并与持续集成服务器（emacsformacosx.com 上的构建使用 Jenkins）集成。这意味着您可以根据可访问的架构进行构建。

请注意，由于 "unexec" 步骤需要运行构建的二进制文件，因此目前无法进行交叉编译 Emacs。如果您想构建旧架构（如 PowerPC），则需要在实际可以执行该架构二进制的系统上运行。

XZ

最近的 Emacs 预测试版本以 .tar.xz 格式分发。fetch-emacs-from-ftp 脚本会将 .xz 转换为 .tar.bz2，以便在每台构建机器上不需要安装 XZ。但是，运行 fetch-emacs-from-ftp 的机器上需要安装 "xz" 程序。最简单的方法是通过 Homebrew 安装：brew install xz。

XCode 命令行工具

构建 Emacs 需要安装 XCode 命令行工具，以便某些库（至少包括 libxml2）可用。

xcode-select --install

目前，Homebrew 为内置的 libxml2 安装了 pkg-config 定义，但在较新版本的 MacOS（至少是 10.14）上默认不存在这些路径。症状是出现以下错误：

CC       xml.o
xml.c:26:10: fatal error: 'libxml/tree.h' file not found
#include <libxml/tree.h>
         ^~~~~~~~~~~~~~~
1 error generated.

要修复它，运行以下命令：

sudo installer -pkg /Library/Developer/CommandLineTools/Packages/macOS_SDK_headers_for_macOS_10.14.pkg -target /

Rust

启动器现在使用 Rust 编写，而不是 Ruby。要构建它，您需要安装 Rust。Rust cargo 调用包装在 Makefile 中，该文件编译 x86_64 和 aarch64，然后使用 Apple 的 lipo 将它们组合成一个胖二进制文件。这要求您为 x86_64 和 aarch64（Apple Silicon）安装了 Rust 编译器目标：

在 aarch64（Apple Silicon）机器上：
```
rustup target add x86_64-apple-darwin
```
在 x86_64（Intel）Mac 上：
```
rustup target add aarch64-apple-darwin
```

Ruby

macOS 10.12 的系统 Ruby（ruby 2.3.7p456）应该能够运行这些脚本。如果您在较旧的 macOS 上尝试构建，可能需要安装更新版本的 Ruby。

2. 项目的使用说明

以下是三个脚本的用法，它们设计用于从某种持续集成软件中运行（emacsformacosx.com 上的构建使用 Jenkins）。所有三个脚本都支持 --verbose 命令，如果给出该命令，它们会输出详细的信息。

fetch-emacs-from-ftp

此脚本接受 ftp url（例如 ftp://ftp.gnu.org/gnu/emacs/），并下载该位置上可用的最新版 Emacs 源代码。它还会将源代码从 .tar.xz 转换为 .tar.bz2（以便主构建虚拟机不需要安装 "XZ"）。

build-emacs-from-tar

这是主要的构建脚本。它接受一个 tar 文件和一个 "kind"（pretest、nightly 或 release）作为输入，解压缩 tar 文件，为单一架构构建，然后压缩生成的 Emacs.app 文件。

您可以使用 --arch 选项指定除默认架构之外的架构（--arch=powerpc 或 --arch=i386）。

Rust 启动器

要编译 Rust 启动器（combine-and-package 所需）：

```
make
```

combine-and-package

此脚本接受多个 tar 文件作为输入，解压缩并将它们组合成最终的 "fat" Emacs.app，然后创建最终的磁盘映像（.dmg）。它接受一个可选的 --sign 参数（--sign="my identity"），用于对 Emacs.app 进行代码签名。

示例

```
$ ./fetch-emacs-from-ftp -v ftp://ftp.gnu.org/pub/gnu/emacs
+ curl --continue-at - --silent -O ftp://ftp.gnu.org/pub/gnu/emacs/emacs-25.1.tar.xz
shell(#<Th:0x007febed8a48b0>): /usr/local//brew//bin/xzcat emacs-25.1.tar.xz
shell(#<Th:0x007febed8a48b0>): /usr/bin/bzip2
$ ls *.bz2
emacs-25.1.tar.bz2
$ ./build-emacs-from-tar -v -j 8 emacs-25.1.tar.bz2 release
  ... 省略了大量输出 ...
已构建 Emacs-25.1-10.12-x86_64.tar.bz2, Emacs-25.1-10.12-x86_64-extra-source.tar
$ ./combine-and-package -v Emacs-25.1-10.12-x86_64.tar.bz2
  ... 省略了更多输出 ...
已创建：Emacs-25.1-universal.dmg
```