为 FreeBSD Ports 做贡献
最后更新于
最后更新于
原文链接：
作者：MATEUSZ PIOTROWSKI
在数个 FreeBSD 版本之前，FreeBSD Ports 是安装第三方软件的主要方式。用户会从 ports 构建他们所需的软件。理论上，有一些二进制包可用，但它们的整体支持并不好。软件包管理工具笨重，软件包库的包是过时的。从 ports 构建软件曾经有此种必要性。
随着新的 pkg(8) 包管理工具的出现，情况开始发生变化。如今，FreeBSD 的软件包库是开源世界中最大、最及时的之一（参见 repology.org 上的图表）。大多数 FreeBSD 用户使用二进制包，而不是自己编译 ports，自从我开始使用 FreeBSD（大约是 10.3 版本）以来，它一直是这样的。
虽然二进制包很棒，但人们仍然时常直接使用 FreeBSD Ports。无论是 FreeBSD 的维护者还是用户，他们都一直在使用它。那为什么 FreeBSD 用户会使用它呢？因为 ports 使得根据非常具体的需求定制二进制包变得非常简单。你想要带有自定义补丁的 Nginx 包吗？没问题。你想为你的 collectd 守护进程添加一个不常见的后端吗？很容易。你想获得 Python 的调试版本吗？没大问题。
在这篇文章中，我想给你一些关于如何贡献到 FreeBSD Ports 的见解。如何开始？为什么要开始？提交补丁需要什么？如果你想知道这些问题的答案，继续阅读吧。
这是我经常看到的信息，无论是在邮件列表、Discord 还是 IRC 频道上。
通常，这类信息会得到一堆指向 bug 跟踪器和 wiki 页面的回复，提供项目想法。你会认为长期贡献者乐于将新手介绍到他们的项目中。这是对的（这也是开源社区健康的标志）。但同样正确的是，长期贡献者往往不愿回复这样的消息。为什么会这样呢？因为他们知道，新手很可能再也不会回复这条信息了。是的，你没听错，基本上这不是你开始贡献开源的方式。别误会，我过去自己也经常发送类似的信息。为什么？因为那时我觉得这是开始的正确方式！我有时间和动力，只需要社区给我一个有趣的项目让我专注。难道不简单吗？
事实证明，它的运作方式稍微有点不同。要全身心投入到某个项目（列在项目想法页面上的那些）几乎是不可能的。项目想法出现在 wiki 页面上，因为没有人有足够的动力花时间做那些工作。如果连有经验的贡献者都觉得这些项目不值得做，那新手又怎么可能去接手呢？我不太确定。有些项目想法必须等到有志之士去推动。
那么如何开始呢？事实上，你需要自己找到你感兴趣的领域。以下是你可以做的事情。开始定期使用 FreeBSD。探索系统，注意那些让你烦恼的地方。问问自己这样的问题：
如果电池电量低，如何让我的笔记本自动进入休眠状态？
GPU 设置文档能否更直观一些？
在应用启动器和菜单中为 Xpdf 添加一个合适的图标该多酷啊？
贡献的最大动力来源于一个想要解决的问题。一个让你烦恼的问题，直到你决定亲自解决它。一个让你难以抗拒的有趣问题，忍不住马上去解决。一个常见的问题，解决它肯定能让你在下次会议上获得赞誉。换句话说，开始贡献的最简单方法是从你需要的事情做起。当然，在某个时候你会卡住。这次不同的是，你手头有一个具体的问题。这些问题在社区中会吸引大量关注。还记得那些“遥不可及”的经验丰富的贡献者吗？相信我，他们会更频繁地回答你的问题，因为你看起来很有动力去解决一些有趣的问题。因为帮助别人解决问题总比帮助别人找到问题更有趣。
本文的这一部分描述了为 FreeBSD ports 开发补丁的工作流程。当我开始为 FreeBSD ports 做贡献时，我常常想，其他人是如何开发他们的补丁的。（现在想想，我仍然对某些 ports 提交者的高效工作流程感到着迷，也许比以往更为着迷。）出于某种原因，官方的 FreeBSD 文档很少描述精确的开发工作流程。那么，废话少说，让我们看看制作一个 ports 补丁需要什么。
这是星期六晚上，阳光明媚，雪正在融化。你正在 FreeBSD 桌面上处理重要的事情。你在处理你日益增多的待办事项清单。逐个任务。下一个任务需要 PDF 阅读器。没问题。我们来用我们尊敬的 Xpdf。于是你启动 Xfce 应用程序查找器，搜索 Xpdf。一切进行得很顺利。然后你看到了它。Xpdf 条目没有合适的图标。想象一下！这不行。我们得修复它。
在我们开始修改 ports 树之前，先来了解一下为什么 Xpdf 图标会缺失。Xfce 应用程序查找器根据位于 /usr/local/share/applications 的桌面文件生成条目列表。
其中名为 /usr/local/share/applications/xpdf.desktop 的文件描述了 Xpdf 条目。让我们看看这个文件中是否与图标相关的内容。
图标的名称是 xpdf。让我们看看是否能在 /usr/local/share/icons 中找到这样一个图标。
我们使用 find(1) 一行命令的输出为空，说明 Xpdf 图标并没有安装。此时，我们可能需要查看一下 ports 树。
我们需要的第一件事是 FreeBSD ports 树的副本。你可以在 FreeBSD 手册中查阅详细信息（https://docs.freebsd.org/en/books/handbook/ports/#ports-using）。最终，我们只需要以下命令：
现在让我们查看 Xpdf 的 port。我们如何在所有 ports 中找到它呢？有几种不同的方法。
最简单的方法是使用 pkg(8) 来查询这个软件包的来源。
pkg-search(8) 会在软件包仓库目录中搜索与 "xpdf" 匹配的软件包名称。-o 选项告诉 pkg-search(8) 在输出中显示软件包的来源。来源是指 ports 树中 port 目录的官方名称，这正是我们要找的内容。
技巧
有时候我不知道安装了我想要修复的文件的软件包名称。在这种情况下，我会使用
pkg-which(8)：
好的，我们已经知道 Xpdf 包的来源是 graphics/xpdf。接下来，让我们看看该 port 目录中有什么内容：
啊哈！对于那些刚接触 ports 的朋友们来说：我们看到的这里并不像一个典型的 port。通常，你会期望看到其他文件，比如 distinfo，其中包含源代码归档的校验和；pkg-descr，它包含 port 的详细描述；以及 pkg-plist，列出了这个 port 安装的所有文件。让我们看看 Makefile 里面有什么内容：
看到第 4 行的 MASTERDIR 变量了吗？这意味着 graphics/xpdf 是一个主 port。当这个 port 被构建时，实际上是 graphics/xpdf4 在驱动整个过程。（顺便说一下，根据第 2 行，Xpdf 版本 4 显然是默认版本）。继续深入探索！
果然不出所料。是时候获取一份源代码了。我们可以通过 FreeBSD Ports 框架定义的 extract 目标来实现这一点。
所有的源代码和构建产物都位于 port 目录中的 ./work 目录下。例如，Xpdf 的源代码会被解压到 work/xpdf-4.03 目录中。
技巧
最好也运行
patch目标。原因是我们希望将所有本地的 FreeBSD ports 补丁应用到新解压的、未修改的源代码上。
好了，我们已经涵盖了所有基础内容。让我们开始挖掘代码吧。Xpdf 的源代码中有图标吗？
太棒了！xpdf-icon.ico 和 xpdf-icon.svg 看起来很有前景。这些文件就是我们需要安装到 /usr/local/share/icons 的文件。为了实现这一点，我们需要编辑 port 的 Makefile，并扩展安装目标。这个 port 已经有了 post-install 目标，因此我们只需要在其中添加四行代码。我们将使用 ${INSTALL_DATA} 来安装图标文件，并使用 ${MKDIR} 来创建目录。这些变量是 FreeBSD Ports 框架中定义的众多包装变量的例子。如果你想了解更多这些变量的信息，可以查看例如 make -V INSTALL_DATA 的输出。到目前为止，补丁应该如下所示：
很好。由于我们现在要安装两个新文件，我们需要将它们添加到打包列表（pkg-plist）中。这个列表可以通过 make makeplist 重新生成，但这次我们手动添加。以下是补丁：
列表中的路径是相对于 ${PREFIX}（默认情况下是 /usr/local）的。行首的 %%GUI%% 表示这些文件只有在启用 GUI 选项时才会被安装（显然，有些人喜欢将他们的 Xpdf 软件设置为无头模式）。
我们需要处理的最后一件事是增加 port 的修订号。待更改进入 ports 树，port 构建者必须知道重新构建带有我们修改的包。增加修订号最简单的方法是使用 portedit（它是 portfmt 包的一部分）：
因此，我们应该在 diff 中看到以下内容：
太好了！现在让我们测试一下我们的更改。为此，我们需要构建并重新安装 Xpdf。以下命令就足够了。你可能想先运行 make missing 并使用 pkg(8) 安装依赖项，以节省时间。
现在是时候检查一下 Xfce 应用程序查找器中的 Xpdf 条目是否有图标了。
成功！
我们需要在提交补丁进行审查之前，再测试一下这个补丁。
Xpdf 是否仍然正常工作？（启动新安装的 Xpdf，看看是否一切正常。）
我们的补丁是否按预期工作？（我们已经在 Xfce 应用程序查找器中看到图标，因此答案是肯定的。）
你能在 Poudriere 中构建 Xpdf 吗？（嗯？）
有一天，你也会开始自己为 FreeBSD ports 树贡献代码。许多人在面对这个挑战时会感到不知所措和害怕，但不要怕！FreeBSD 社区总是准备好帮助你。IRC 频道、邮件列表、论坛，最近还有 Discord，都是与其他 FreeBSD 人员交流和提问的好地方。
最重要的是，在 FreeBSD 上进行黑客开发时要享受其中的乐趣，并享受与 FreeBSD 人员一起度过的时光。我们在动物园见！
MATEUSZ PIOTROWSKI 是一位 FreeBSD ports 和文档提交者，现居柏林。他喜欢调试 bug、编写自动化脚本以及设计健壮的软件系统（在此过程中总是详细记录一切）。最近，他的兴趣转向了追踪和性能工程。当他不在处理现代软件的表面上看似决定性的电路时，他正在探索社会和文化中不断变化的动态。
Poudriere 的设置可以在 FreeBSD Porter’s Handbook 的“测试 Port”章节中找到详细解释：
FreeBSD Bugzilla 是贡献者上传补丁并建议更改的服务：。整个过程相当简单。首先，你需要创建一个账户并登录。然后通过点击顶部导航栏中的“New”来打开一个新的问题报告（PR）。记得在摘要前加上“graphics/xpdf4”作为前缀，这样 port 的维护者就会收到关于 PR 的通知（更多关于如何撰写好 PR 的建议可以参考这里：）。有时候，除了在 Bugzilla 上打开 PR，人们还会将补丁提交到 Phabricator。这项服务有更好的界面用于代码审查。
哦，顺便说一下，Xpdf 图标缺失的问题确实是基于真实的故事。我已经在 Bugzilla 上报告了这个 Xpdf 的问题（），并将我的补丁发布到 Phabricator（）。Xpdf 的维护者审查了我的补丁并批准了提交更改。由于我是一个 ports 提交者，我自己提交了这个更改。