1. 概述

说明

1. 点击这里，查看制作 Openresty RPM 包的 SPEC 文件

2. 本文运行环境：

   • 操作系统：CentOS Linux release 7.8.2003 (Core)
   • rpm/rpmbuild：RPM version 4.11.3

常见的 Linux 发行版主要分为两类：类 RedHat 系列和类 Debian 系列。在类 RedHat 系统中，软件包的格式是 rpm；在类 Debian 系统中，软件包的格式是 deb。类 RedHat 系统提供 rpm（RedHat Package Manager）命令，用于安装、卸载和升级 RPM 软件包；类 Debian 系统提供 dpkg 命令，用于安装、卸载和升级 DEB 软件包。

CentOS 提供 yum 工具，自动解决软件包的安装依赖，yum 本质上还是调用 rpm。不同发行版上的包管理工具，如下所示：

2. 目录结构

从运行结构来看，软件主要分为三部分：可执行程序、配置文件和动态链接库。还可能包含可选的头文件、手册、示例程序等。

本文主要讲述如何使用 rpmbuild 制作 RPM 包，rpmbuild 的输入对象是 SPEC 文件，下面开始介绍 SPEC 文件。

对于版本小于等于 4.4.x 的 rpm，rpmbuild 的默认工作目录是 /usr/src/redhat，这使得普通用户无法制作 RPM 包。所以从版本 4.5.x 开始，rpmbuid 的默认工作路径被移动到 $HOME/rpmbuild，并且建议用户在制作 RPM 包时，尽量不要使用 root 身份进行操作。rpmbuild 的默认工作路径通常由 /usr/lib/rpm/macros 文件里的 %{_topdir} 宏定义。如果用户想要更改 rpmbuild 的工作路径，那么可以在用户的家目录下创建一个名为 .rpmmacros 的隐藏文件，然后在其中重新定义 %{_topdir}。比如：

xxxxxxxxxx
%_topdir    %{getenv:HOME}/myrpmbuildenv

在 %{_topdir} 目录下，一般需要建立 6 个目录：

• BUILD：

  • 编译源代码的临时目录所在的目录
  • 通过 $RPM_BUILD_DIR 引用该目录
  • 在 macros 文件中的宏名为 %{_builddir}

• BUILDROOT：

  • “虚拟根目录”所在的目录。该参数非常重要，执行 make install 时，软件被安装到“虚拟根目录”。所有需要打包进 RPM 包的文件或目录，也要拷贝到“虚拟根目录”。简而言之，打包时，以“虚拟目录”为“根目录”进行操作。最终的 RPM 包中的文件都来自于“虚拟根目录”。（在 %files 阶段，书写将要打包的文件列表时，必须以宏或 “/” 开头，其中 “/” 代表“虚拟根目录”）
  • 可以通过 $RPM_BUILD_ROOT 引用“虚拟根目录”
  • 也可以通过 %{buildroot} 引用“虚拟根目录”
  • 在 macros 文件中的宏名为 %{_buildrootdir}

• RPMS：

  • 最终生成的 RPM 包所在的目录
  • 在 macros 文件中的宏名为 %{_rpmdir}

• SOURCES：

  • 源代码和补丁文件所在的目录
  • 在 macros 文件中的宏名为 %{_sourcedir}

• SPECS：

  • SPEC 文件所在的目录
  • 在 macros 文件中的宏名为 %{_specdir}

• SRPMS：

  • 软件最终的 RPM 源码格式存放路径
  • 在 macros 文件中的宏名为 %{_srcrpmdir}

在建立上述目录之后，将用于生成 RPM 包的所有源代码、Shell 脚本、配置文件拷贝到 SOURCES目录。通常情况下，源代码的格式是 *.tar.gz，SPEC 文件的命名格式是“软件名-版本.spec”。将 SPEC 文件拷贝到 SPECS 目录，cd 到 SPECS 目录，然后执行：

xxxxxxxxxx
rpmbuild -bb 软件名-版本.spec

最终生成的 RPM 包在 RPMS 目录。

3. SPEC 文件的头部

SPEC 文件分为头部和阶段。阶段有多个，比如 %prep、%build、%install、%clean、%files、%pre、%post、%preun、%postun 等。执行 rpmbuild 时，它首先解析 SPEC 文件，然后依次执行每个阶段里的指令。

接下来，简单地介绍 SPEC 文件的头部：

• Name：软件包的名称，后面可以使用 %{name} 引用，比如 protobuf
• Version：软件包的版本，后面可以使用 %{version} 引用，比如 3.0.0
• Release：发布序号，标明第几次打包，后面可以使用 %{release} 引用，比如 1%{?dist}
• Summary：软件包的摘要
• Group：软件包的安装分类，参见 /usr/share/doc/rpm-4.x.x/GROUPS 文件，建议使用标准分组。创建者在创建包时，需要对包进行分类，以便将功能相似的包放在一起。rpm 命令可以通过分组查询包。比如有一个名为 System Environment/Base 的分组，该分组中的包提供比较底层的功能，可以通过 rpm 命令查看该分组由哪些包组成：rpm -qg "System Environment/Base"
• License：授权方式，通常是 GPL
• URL：软件的主页
• Source0：源代码包的名称（rpmbuild 命令将到 %{_sourcedir} 目录中寻找），如前所述，源代码的压缩格式是 *.tar.gz，比如 %{name}-%{version}.tar.gz，其中 name 和 version 是前面两行定义的值。如果还有其它配置或脚本，那么依次使用 Source1、Source2 等向后追加即可，后面可以使用 %{SOURCE0}、%{SOURCE1} 等引用
• BuildRoot：“虚拟根目录”
• BuildRequires：在本机编译 RPM 包时，所依赖的软件包名称。可以用 >= 或 <= 表示大于等于或小于等于某一特定版本。注意：>= 两边需要用空格隔开，不同的软件名称也用空格（或逗号）分开，比如 gcc >= 4.2.2, make
• Requires：RPM 包所依赖的软件名称，类似的还有 PreReq、Requires(pre)、Requires(post)、Requires(preun)、Requires(postun) 等，它们是针对不同阶段的依赖指定
• BuildArch：指定目标处理器的架构，noarch 表示不指定，默认值是 /usr/lib/rpm/marcros 文件中的 %{_build_arch}，比如 BuildArch: noarch
• Packager：打包者的信息
• Provides：本软件的一些特定功能
• %description：软件包的详细说明，不能超过 80 个英文字符
• Distribution：发行版本标识
• Vendor：发行商的信息
• Patch0：补丁文件的名称。如果有多个补丁文件，那么依次使用 Patch1、Patch2 等向后追加，后面可以使用 %patch0 或 %{patch0} 等引用

4. SPEC 文件中的阶段

• %prep 阶段

  • 动作：将 %_sourcedir 目录中的源代码包解压到 %_builddir 目录，如果需要给源代码打补丁，那么也在该阶段进行

  • 解压缩时，最常用的指令是 %setup，并且只有 *.tar.gz 格式的源代码包才被解压缩。%setup 还将完成后续阶段的目录切换和设置，如果在该阶段不用这条指令，那么后续阶段需要手动更改相应的目录。%setup 常用的选项如下：

    • %setup（不加任何选项）仅将软件包解开
    • %setup -c 解压缩前，先产生目录
    • %setup -n <newdir> 将源代码解压到 newdir 目录
    • %setup -b <num> 将第 num 个 SOURCE 文件解压缩
    • %setup -c -n <newdir> 将源代码解压到 newdir 目录，并且在解压缩前，先产生目录

  • 使用 %patch 打补丁。比如 %patch0 -p1 表示使用前面定义的 Patch0 打补丁，并且忽略第 1 层目录

• %build 阶段

  • 动作：在临时目录（%_builddir）执行源代码的编译，通常是执行 ./configure 和 make 指令。如果软件需要先执行 bootstrap 之类的操作，那么可以放在 configure 之前
  • 该阶段最常见的两条指令是 %configure、make %{?_smp_mflags}。其中 %configure 是 RPM 定义的标准宏指令，它自动地将 --prefix 设置为 /usr。此外该宏还可以接受额外参数。如果不用 %configure，那么需要完全手动地指定 configure 时的配置参数。同样也可以给 make 传递额外的参数，比如 make %{?_smp_mflags} OPTIMIZE="%{optflags}"，其中 %{optflags} 是 /usr/lib/rpm/marcros 中定义的优化参数

• %install 阶段

  • 动作：

    • 执行 make install，将软件安装到“虚拟根目录”
    • 在“虚拟根目录”中，创建目录结构，并且将需要打包进 RPM 包的文件或目录拷贝到“虚拟根目录”下相应的目录中。当安装 RPM 包时，这些文件或目录将被安装到用户系统相应的位置

  • 该阶段最常用的指令是 rm -rf $RPM_BUILD_ROOT、make install DESTDIR=$RPM_BUILD_ROOT

  • 如果软件拥有额外的配置文件或启动脚本，那么需要手动用 cp 或 install 命令将它们拷贝到“虚拟根目录”。比如 install -d $RPM_BUILD_ROOT/、cp -a * $RPM_BUILD_ROOT/。（这里的相对路径是相对于“编译软件的临时目录”的；同时也可以使用 %{SOURCE1} 等从源代码目录下拷贝文件）

• %clean 阶段

  • 动作：执行编译后的清理工作，比如执行 make clean 清除“虚拟根目录”等

• %files 阶段

  • 动作：制作 RPM 包时的阶段，主要用于说明将“虚拟根目录”下的哪些文件和目录打包进 RPM 包里。所有需要打包进 RPM 包的文件和目录都需要在 %files 下列出
  • 编写文件列表时，必须以 “/” 开头（也可以以宏常量开头，宏常量本质上也以 “/” 开头），表示从“虚拟根目录”中将文件拷贝到最终的 RPM 包中
  • %exclude 用于列出不想打包进 RPM 包中的目录或文件。如果 %exclude 指定的文件不存在，那么将报错
  • “虚拟根目录”中的所有文件都需要明确地被指定是否被打包进 RPM 包。比如，“虚拟根目录”下有 4 个目录 a、b、c 和 d，在 %files 中仅指定将 a 和 b 打包进 RPM 包中，如果不使用 %exclude 声明 c 和 d，那么将报错。如果声明“虚拟根目录”里不存在的文件或目录，那么也将报错
  • %defattr(<文件权限>，<用户名>，<组名>，<目录权限>) 用于指定文件和目录的属性，“-” 表示默认权限，对于文本文件，为 0644，对于可执行文件，是 0755
  • 所有跟在 %doc 宏后面的文件都来自“编译软件的临时目录”，这个宏所指定的文件将被安装到 /usr/share/doc/<name>-<version>/ 目录

• %changelog

  • 动作：记录每次打包时的变更日志。标准格式是

    xxxxxxxxxx
    * date +"%a %b %d %Y" 修改人 邮箱 本次版本
    - 内容
    

下面是可选的阶段：

• %pre 安装或者升级软件前需做的事情，比如停止服务，备份相关文件等
• %post 安装或者升级完成后需要做的事情，比如执行 ldconfig 重构动态链接库缓存，启动服务等
• %preun 卸载软件前需要做的事情，比如停止相关服务，关闭进程等
• %postun 卸载软件后需要做的事情，比如删除备份，配置文件等（升级 RPM 包时，将执行 %preun，但不执行 %postun）

5. 其它

如果准备将正在制作的 RPM 包放到系统安装光盘中，那么需要考虑 RPM 包中定义的脚本是否有问题。由于系统安装时只依赖于一个“小”环境，该环境与实际安装完成的环境有很大区别，所以大部分脚本在该安装环境中无法生效，甚至带来麻烦。

因此对于需要放到安装光盘中的套件，较好的方法是不加入执行脚本。

此外，RPM 还提供一种信号机制 - 不同操作返回不同信息，并且保存到 $1 中（0 代表卸载；1 代表安装；2 代表升级）：

xxxxxxxxxx
%postun
if [ "$1" = "0" ]; then
    /sbin/ldconfig
fi

下面是 RPM 包用到的一些文件和目录：

• 标准分组：/usr/share/doc/rpm-4.x.x/GROUPS

• 宏定义：/usr/lib/rpm/macros

• 已安装的 RPM 包数据库：/var/lib/rpm

• 避免生成 debuginfo 包：

  xxxxxxxxxx
  echo '%debug_package %{nil}' >> ~/.rpmmacros 
  

在安装的时候，修改默认路径：

xxxxxxxxxx
rpm -ivh --prefix=/opt/usr XXX.rpm

或者同时修改多个路径：

xxxxxxxxxx
rpm XXX.rpm --relocate=/usr=/opt/usr --relocate=/etc=/usr/etc

6. 补丁文件

6.1. 使用 diff 命令，生成补丁文件

diff 命令用于比较文件的内容，找到改动的地方。diff 的输出称为补丁（patch），Linux 系统中的 patch 命令可以根据 diff 程序的输出，将源文件的内容更新为目标文件。diff 是 SVN、Git 等版本控制工具不可或缺的一部分。

diff 可以比较单个文件或目录。如果比较单个文件，那么只有当输入文件是文本文件时才有效，diff 以逐行的方式，比较文本文件的异同。如果比较目录，那么 diff 将比较两个目录下文件名相同的文本文件，并且列出不同的二进制程序、公共子目录和只在一个目录中出现的文件。

命令格式为：

xxxxxxxxxx
diff [参数] [文件 1 或目录 1 ] [文件 2 或目录 2]

常用参数包括：

• -r 或 --recursive：递归地比较子目录
• -N 或 --new-file：比较目录时，如果文件 A 只出现在一个目录中，那么默认显示：Only in 目录: 文件 A。如果使用 -N 参数，那么 diff 将文件 A 与空白文件进行比较
• -u 或 --unified：以合并的方式，显示文件的不同
• -c 显示文件的全部内容，并且标出不同之处

下面通过几个示例进行说明，示例文件如下：

xxxxxxxxxx
├── a
│   └── sub
│       └── 1.txt
└── b
    └── sub
        └── 1.txt

a/sub/1.txt：

xxxxxxxxxx
1
2
3
4
5

b/sub/1.txt:

xxxxxxxxxx
1
4.1
5
6
7
8

示例 1：

xxxxxxxxxx
$ diff a/sub/1.txt b/sub/1.txt
2,4c2
< 2
< 3
< 4
---
> 4.1
5a4,6
> 6
> 7
> 8

2,4c2 的含义如下：

前面的数字 2,4 表示第一个文件中的行，中间的字母 c 表示需要在第一个文件上执行的操作（a=add、c=change、d=delete），后面的数字 2 表示第二个文件中的行。也就是说，第一个文件中的第 [2, 4] 行需要做出修改才能与第二个文件中的第 2 行匹配。

接下来的内容是需要修改的地方，前面带 < 的部分表示左边文件的第 [2, 4] 行的内容，带 > 的部分表示右边文件第 2 行的内容，中间的 - 则是两个文件内容的分隔符。

示例 2：

xxxxxxxxxx
$ diff -c a/sub/1.txt b/sub/1.txt
*** a/sub/1.txt ...
--- b/sub/1.txt ...
***************
*** 1,5 ****
  1
! 2
! 3
! 4
  5
--- 1,6 ----
  1
! 4.1
  5
+ 6
+ 7
+ 8

说明：

• “+” 表示后者比前者多了该行
• “-” 表示前者比后者多了该行
• “!” 表示两者在该行有差别

示例 3：

xxxxxxxxxx
$ diff -u a/sub/1.txt b/sub/1.txt
--- a/sub/1.txt ...
+++ b/sub/1.txt ...
@@ -1,5 +1,6 @@
 1
-2
-3
-4
+4.1
 5
+6
+7
+8

说明：

• “---” 表示变动前的文件
• “+++” 表示变动后的文件
• 变动的位置用两个 “@” 作为起始和结束标记。
• -1,5 中的 - 表示第一个文件；1 表示第 1 行；5 表示连续的 5 行。合在一起，表示下面是第一个文件的第 1 行开始的连续 5 行。同理，+1,6 表示第二个文件的第 1 行开始的连续 6 行

示例 4：

xxxxxxxxxx
# diff -uNr a b | tee patch.log
diff -uNr a/sub/1.txt b/sub/1.txt
--- a/sub/1.txt ...
+++ b/sub/1.txt ...
@@ -1,5 +1,6 @@
 1
-2
-3
-4
+4.1
 5
+6
+7
+8

说明：

• 比较两个目录，并且生成补丁文件

6.2. 使用 patch 命令，打补丁

patch 用 diff 制作的补丁，实现源文件（目录）和目标文件（目录）的相互转换。常用的选项有：

• -p <NUM>：表示忽略 NUM 层目录

  比如：

  xxxxxxxxxx
  --- a/a.txt ...
  +++ b/a.txt ...
  

  参数 -p0 表示在当前目录下寻找目录 a，然后在目录 a 下面寻找文件 a.txt，执行 patch 操作。

  参数 -p1 表示忽略第 1 层目录，即忽略 a，在当前目录下寻找文件 a.txt

• -E：在打完补丁后，如果发现空文件，那么就删除它

• -R：给新版本打上补丁，使其变为老版本

• -b：备份每个文件的原始内容

示例 1：

使用上一小节的示例 4 生成的 patch.log。

x
# 进入 a/ 目录
$ patch -p1 < ../patch.log
patching file sub/1.txt

# 进入 b/ 目录
$ patch -R -p1 < ../patch.log
patching file sub/1.txt

说明：

• 最终 a 变成 b；b 变成 a

7. RPM SPEC 示例

示例文件：

x
rpmbuild/
├── BUILD
├── BUILDROOT
├── RPMS
├── SOURCES
│   └── hello_world.sh
├── SPECS
│   └── rpmtester.spec
└── SRPMS

rpmbuild/SOURCES/hello_world.sh：

xxxxxxxxxx
#!/bin/sh

export PATH=$PATH:/bin
echo -e "\033[32mHello World.\033[0m"

rpmbuild/SPECS/rpmtester.spec：

xxxxxxxxxx
Name:   rpmtester
Version:  1.0
Release:  1%{?dist}
Summary:  rpm tester

Group:    Development/Tools
License:  GPL
URL:    http://timd.cn/rpm/
Source0:        hello_world.sh

%description
rpm tester

%install
%{__install} -d %{buildroot}/opt/mypackage
%{__install} -m 0755 %SOURCE0 %{buildroot}/opt/mypackage/hello_world.sh

%files
%defattr(-, root, root, -)
/opt/mypackage/hello_world.sh

%changelog
* Wed Aug 24 2016 Tim 744475502@qq.com 1.0-1
- initialization

打包：

xxxxxxxxxx
$ rpmbuild -bb rpmbuild/SPECS/rpmtester.spec

生成的 RPM 包在：

xxxxxxxxxx
rpmbuild/RPMS/x86_64/rpmtester-1.0-1.el7.x86_64.rpm

安装 RPM 包：

xxxxxxxxxx
$ sudo rpm -ivh rpmbuild/RPMS/x86_64/rpmtester-1.0-1.el7.x86_64.rpm
Preparing...                          ################################# [100%]
  package rpmtester-1.0-1.el7.x86_64 is already installed

运行安装的命令：

xxxxxxxxxx
$ /opt/mypackage/hello_world.sh
Hello World.