3.2.编写描述文件

无论是否实际打包,每个 Port 都需要两个描述文件:pkg-descrpkg-plist。它们的前缀 pkg- 用于与其他文件区分开来。

3.2.1 pkg-descr

这是 Port 的详细描述。简洁地解释 Port 做什么的一到几段文字足够了。

注意:

这不是一份手册,也不是深入解释如何使用或编译 Port!请小心地从 README 或 man 页面中复制内容。它们往往不是 Port 的简洁描述,或者格式不正确。例如,man 页面使用了对齐间距,这在等宽字体中看起来特别糟糕。

另一方面,pkg-descr 的内容必须比 Makefile 中的 COMMENT 行更详细。它必须更深入地解释 Port 的内容。

一个写得很好的 pkg-descr 应该足够完整,以至于用户不需要查阅文档或访问网站就能理解软件做什么,它有什么用,或者有什么特性。

注意:

以前在 pkg-descr 文件的最后一行包含的链接已经移动到 Makefile 中。

3.2.2 pkg-plist

这个文件列出了 Port 安装的所有文件。它也被称为“打包清单”,因为打包是通过打包这里列出的文件来生成的。这里的路径名是相对于安装前缀(通常是 /usr/local)的。

bin/oneko
man/man1/oneko.1.gz
lib/X11/app-defaults/Oneko
lib/X11/oneko/cat1.xpm
lib/X11/oneko/cat2.xpm
lib/X11/oneko/mouse.xpm

详细的打包清单信息,请参阅 man:pkg-create[8] 手册页。

注意:

建议按字母顺序排列此文件中的所有文件名。这将使升级 Port 时验证更改变得更容易。

最后更新于

FreeBSD 中文社区