GREADME.ECLASS

章节: eclass-manpages (5)
更新: 2024 年 11 月
索引返回主内容

名称

greadme.eclass - 安装一个文档文件，该文件将通过 elog 消息有条件地显示

描述

一个用于安装包含重要用户信息的 README.gentoo 文档文件的 eclass。README.gentoo 的内容将通过 elog 消息显示，无论是新安装还是文件内容发生更改。此外，README.gentoo 文件将安装在 /usr/share/doc/${PF} 下供以后参考。

此 eclass 受 readme.gentoo-r1.eclass 的启发。主要区别如下。首先，它只在文档文件内容发生更改时才显示它们（除非设置了 GREADME_SHOW）。其次，它提供了一个便捷的 API 通过标准输入安装文档文件。

inherit greadme

src_install() {
  ...
  greadme_stdin <<-EOF
  This is the content of the created readme doc file.
  EOF
  ...
  if use foo; then
    greadme_stdin --append <<-EOF
    This is conditional readme content, based on USE=foo.
    EOF
  fi
}

如果 ebuild 覆盖了默认的 pkg_preinst 或相应的 pkg_postinst，那么它必须显式调用 greadme_pkg_preinst 和 greadme_pkg_postinst。

支持的 EAPIS

函数

greadme_stdin [--append]: 通过标准输入创建 readme 文档。可以使用 --append 将其追加到现有 readme 文档。
greadme_file <file>: 安装提供的文件作为 readme 文档。
greadme_pkg_preinst: 执行检查，例如比较镜像中的 readme 文档与实际系统中可能存在的文档。
greadme_pkg_postinst: 有条件地通过 elog 显示 readme 文档的内容。

ECLASS 变量

GREADME_SHOW: 如果设置为 "yes"，则在 pkg_postinst 中通过 elog 无条件地显示 readme 文件的内容。如果设置为 "no"，则即使内容发生更改也不显示 readme 文件的内容。
GREADME_DISABLE_AUTOFORMAT: 如果非空，则不会自动格式化 readme 文件。

维护人员

Florian Schmaus <[email protected]>

报告漏洞

请通过 https://bugs.gentoo.org/ 报告漏洞

文件

greadme.eclass

另请参阅

ebuild(5)
https://gitweb.gentoo.org/repo/gentoo.git/log/eclass/greadme.eclass

本文件由 man2html 创建，使用手册页。
时间: 2024 年 11 月 12 日 03:27:00 GMT