README.GENTOO-R1.ECLASS
部分: eclass-manpages (5)更新: 2024 年 11 月
索引 返回主内容
名称
readme.gentoo-r1.eclass - 安装通过 elog 消息显示的文档文件描述
一个用于安装 README.gentoo 文档文件的 eclass，该文件记录通过 elog 消息显示的提示。使用此 eclass，这些 elog 消息仅在首次安装软件包时显示，并且用于稍后查看的文件将安装在 /usr/share/doc/${PF} 下您需要在 src_install 阶段调用 readme.gentoo_create_doc 并在 pkg_postinst 阶段调用 readme.gentoo_print_elog
支持的 EAPIS
7 8功能
- readme.gentoo_create_doc
- 使用 ${DOC_CONTENTS} 变量创建文档文件（首选），如果未设置，则查找 "${FILESDIR}/README.gentoo" 内容。您也可以使用 ${FILESDIR}/README.gentoo-${SLOT}。通常在 src_install 阶段调用。
- readme.gentoo_print_elog
- 使用 "${T}"/README.gentoo 内容打印 elog 消息。它们仅在软件包首次安装时显示。通常在 pkg_postinst 阶段调用。
如果您想始终显示它们，请在调用此函数之前，在您的 ebuild 中将 FORCE_PRINT_ELOG 设置为非空值。这在 DOC_CONTENTS 被修改时很有用，然后，您可以依赖 ebuild 中的特定 REPLACING_VERSIONS 处理来在人们从仍然提供旧消息的版本更新时打印消息。
ECLASS 变量
- DOC_CONTENTS
- 用于创建 README.gentoo 文件的信息。
- DISABLE_AUTOFORMATTING
- 如果非空，DOC_CONTENTS 信息将被严格尊重，不会被 fold 自动格式化。如果为空，它将依赖 fold 进行格式化并使用 'echo -e' 选项稍微调整行。
- FORCE_PRINT_ELOG
- 如果非空，此变量强制打印 elog 消息。
- README_GENTOO_SUFFIX ?= ""
- 如果您想为 README.gentoo 文件指定后缀，请导出它。
作者
作者: Pacho Ramos <[email protected]>维护者
Pacho Ramos <[email protected]>报告 Bug
请通过 https://bugs.gentoo.org/ 报告 Bug文件
readme.gentoo-r1.eclass另请参阅
ebuild(5)https://gitweb.gentoo.org/repo/gentoo.git/log/eclass/readme.gentoo-r1.eclass
索引
本文件由 man2html 使用手册页创建。
时间: 2024 年 11 月 12 日，格林威治标准时间 03:27:01