获取 Gentoo！

GLEP 43：GLEP 文件托管

作者 Ciaran McCreesh <ciaranm@gentoo.org>
类型 信息
状态 最终版
版本 1
创建时间 2005-11-07
上次修改时间 2014-01-23
发布历史 2005-11-07
GLEP 源代码 glep-0043.rst

摘要

本 GLEP 建议创建一个可靠的托管位置，用于存放与 GLEP 相关的數據（例如示例代码）。

状态

本 GLEP 已获得 GLEP 编辑的批准，并于 2005 年 11 月 13 日标记为最终版。

动机

有些 GLEP 附带了一些重要的示例文件或代码，这些文件或代码是规范的一部分。以前处理此问题的两种方法是

  • 使用代码（::）段在 GLEP 中内联包含代码。对于较大的代码示例，这不太理想，因为它会导致大量混乱。
  • 将文件放置在开发人员的网站空间上dev.gentoo.org上。这不可靠，因为开发人员可能会离开或意外地重组他们的网站空间，而 GLEP 旨在成为一个永久规范。

本 GLEP 建议允许 GLEP 作者使用 Gentoo 主网站服务器来托管与其 GLEP 相关的內容。

重要

所建议的托管用于与提案相关的文件（例如，阐明规范部分的示例代码），而不是提案的完整实现。

规范

分配 GLEP 号码后，开发人员（或 GLEP 编辑）可以在 CVS 中创建一个名为glep-xxxx-extras/的目录（其中xxxx是 GLEP 的编号）位于主 GLEP 目录下。此目录可用于存放提案的一部分的文件。

指向此目录中文件的任何超链接都应使用相对路径。这可以防止目录结构更改导致链接失效。

使用此目录的 GLEP 可以包含一个“示例文件”标题，其中列出指向相关文件的链接。

示例

请考虑以下 GLEP 段，该段摘自 GLEP 42 的草稿 [1]

Example News Item
'''''''''''''''''

The following hypothetical news item could be used for an upgrade to the
``YourSQL`` database format which breaks forward compatibility. It should be
named ``2005-11/2005-11-01-yoursql-upgrades.en.txt``.

::

    # Lots and lots of lines of example news item

该新闻条目显然是提案的一部分，但将其内联包含进去会很混乱。根据本提案，主 GLEP 段将读取为

Example News Item
'''''''''''''''''

`This hypothetical news item`__ could be used for an upgrade to the
``YourSQL`` database format which breaks forward compatibility. It would be
named ``2005-11/2005-11-01-yoursql-upgrades.en.txt``.

.. __: glep-0042-extras/example-news-item.txt

示例新闻条目将放置在glep-0042-extras/example-news-item.txt.

中。对较长的示例代码段也会进行类似的更改。GLEP 还可以新增类似以下内容的章节

Example Files
=============

`example-news-item.txt <glep-0042-extras/example-news-item.txt>`_
    An example news item.
`news-mailer.bash <glep-0042-extras/news-mailer.bash>`_
    A ``bash`` script which delivers news items via email.

向后兼容性

不是问题。

参考文献

[1]GLEP 42：重要新闻报道，Ciaran McCreesh，https://gentoolinux.cn/glep/glep-0042.html