Next: , Previous: , Up: 贡献   [Contents][Index]


16.6 提交补丁

Development is done using the Git distributed version control system. Thus, access to the repository is not strictly necessary. We welcome contributions in the form of patches as produced by git format-patch sent to the guix-patches@gnu.org mailing list. Seasoned Guix developers may also want to look at the section on commit access (see 提交权利).

This mailing list is backed by a Debbugs instance, which allows us to keep track of submissions (see Tracking Bugs and Patches). Each message sent to that mailing list gets a new tracking number assigned; people can then follow up on the submission by sending email to NNN@debbugs.gnu.org, where NNN is the tracking number (see 发送补丁系列).

请以ChangeLog格式(see Change Logs in GNU代码规范)写commit日志;你可以浏览commit历史里的例子。

提交添加或者修改软件包定义的补丁之前,请过一遍这个检查列表:

  1. 如果软件包的作者为发布的文件包提供了密码学签名,请验证文件的真实性。对于独立的 GPG 签名文件,这可以通过 gpg --verify 命令完成。
  2. 花些时间为软件包提供一个合适的简介和描述。更多指导,See 简介和描述
  3. 运行guix lint 软件包软件包是新添加的或修改过的软件包的名字,修复它报告的错误(see 调用guix lint)。
  4. guix build 软件包命令确保这个软件包可以在你的平台上构建。
  5. 我们建议你同时尝试在别的支持的平台上构建这个软件包。你可能没有别的平台的真实的硬件,我们推荐使用qemu-binfmt-service-type来模拟它们。为了启用这个功能,把下面这个服务添加到你的操作系统配置的服务列表里:
    (service qemu-binfmt-service-type
     (qemu-binfmt-configuration
       (platforms (lookup-qemu-platforms "arm" "aarch64"))
    

    然后重新配置你的系统。

    你之后可以用--system参数为不同的平台构建软件包。例如,为armhf,aarch64,或mips64架构构建"hello"软件包,你可以依次运行如下的命令:

    guix build --system=armhf-linux --rounds=2 hello
    guix build --system=aarch64-linux --rounds=2 hello
    
  6. 请确保软件包里不捆绑出现已经被打过包的软件的副本。

    有时,软件包为了方便用户,捆绑了依赖库的源代码。然而,当依赖库在发行版里已经存在时,做为一个发行版,我们希望确保这些软件包使用发行版里已有的副本。这提高资源使用率(依赖库只构建一次,存储一份),并且使发行版更容易管理,如仅在一个地方对某个软件包进行安全更新就可以影响整个系统--捆绑软件会妨碍这么做。

  7. Take a look at the profile reported by guix size (see 调用guix size). This will allow you to notice references to other packages unwillingly retained. It may also help determine whether to split the package (see 有多个输出的软件包), and which optional dependencies should be used. In particular, avoid adding texlive as a dependency: because of its extreme size, use the texlive-tiny package or texlive-union procedure instead.
  8. 对于重要的更改,确保依赖它的软件包没有受到影响。guix refresh --list-dependent 软件包会帮你检查(see 调用guix refresh)。

    取决于受影响的软件包的数量,即需要重新构建的数量,commit需要被提交到不同的分支,具体如下:

    300个或更少的受影响的软件包

    master分支(非破坏性的更改)。

    300 至 1800 个受影响的软件包

    staging branch (non-disruptive changes). This branch is intended to be merged in master every 6 weeks or so. Topical changes (e.g., an update of the GNOME stack) can instead go to a specific branch (say, gnome-updates).

    超过 1800 个受影响的软件包

    core-updates branch (may include major and potentially disruptive changes). This branch is intended to be merged in master every 6 months or so.

    所有这些分支都被构建农场跟踪,并且当一切都被顺利构建时合并进master。这使我们在影响到用户之前就能改正问题,并且缩小没有准备好预构建的二进制包的窗口期。

    When we decide to start building the staging or core-updates branches, they will be forked and renamed with the suffix -frozen, at which time only bug fixes may be pushed to the frozen branches. The core-updates and staging branches will remain open to accept patches for the next cycle. Please ask on the mailing list or IRC if unsure where to place a patch.

  9. 检查软件包的构建过程是不是确定性的。这通常意味着检查对软件包的独立构建是否能得到每一个比特都完全相同的结果。

    为此,一个简单的做法是在你的机器上多次构建同一个软件包(see 调用guix build):

    guix build --rounds=2 <我的软件包>
    

    这足以查出一批普通的不确定性问题,如构建结果里存在时间戳或随机生成的输出。

    另一个选择是使用guix challenge(see 调用guix challenge)。当软件包被提交并且被ci.guix.gnu.org构建之后,你可以运行这个命令检查你是否得到相同的构建结果。更好的:找另一台可以构建的机器,运行guix publish。由于远程的构建机器很可能和你的机器不同,这可以捕捉到由硬件不同引起的不确定性问题--如,使用不同的指令集--或不同操作系统内核引起的问题--如,对uname/proc文件的依赖。

  10. 在编写文档时,请用性别中立的词语指代人,如“他”, “他的”,等。
  11. 检查你的补丁只包含一些相关的更改。把不相关的更改捆绑在一起会让评审更困难和更慢。

    不相关的更改的例子有:同时新增多个软件包,或更新软件包同时修补这个软件包。

  12. 请遵守我们的代码格式规范,最好运行etc/indent-code.el脚本以自动为你格式化(see 格式化代码)。
  13. 当可能时,请在源URL里使用镜像see 调用guix download。使用可靠的而不是生成的URL。例如,GitHub的下载文件每次生成时不一定是相同的,所以这时最好克隆仓库。不要在URL里使用name变量:这没有什么用,而且如果名字变了,URL很可能就错了。
  14. Check if Guix builds (see 从Git构建) and address the warnings, especially those about use of undefined symbols.
  15. Make sure your changes do not break Guix and simulate a guix pull with:
    guix pull --url=/path/to/your/checkout --profile=/tmp/guix.master
    

When posting a patch to the mailing list, use ‘[PATCH] …’ as a subject, if your patch is to be applied on a branch other than master, say core-updates, specify it in the subject like ‘[PATCH core-updates] …’. You may use your email client or the git send-email command (see 发送补丁系列). We prefer to get patches in plain text messages, either inline or as MIME attachments. You are advised to pay attention if your email client changes anything like line breaks or indentation which could potentially break the patches.

当一个bug被修复时,请通过向NNN-done@debbugs.gnu.org发邮件的方式关闭thread。

发送补丁系列

When sending a patch series (e.g., using git send-email), please first send one message to guix-patches@gnu.org, and then send subsequent patches to NNN@debbugs.gnu.org to make sure they are kept together. See the Debbugs documentation for more information. You can install git send-email with guix install git:send-email.


Next: , Previous: , Up: 贡献   [Contents][Index]