Gentoo Development Guide

README.GENTOO

Section: portage (5)
Updated: Apr 2014
Index Return to Main Contents
 

NAME

readme.gentoo - An eclass for installing a README.gentoo doc file recording tips  

FUNCTIONS

readme.gentoo_create_doc
Create doc file with ${DOC_CONTENTS} variable (preferred) and, if not set, look for "${FILESDIR}/README.gentoo" contents. You can use ${FILESDIR}/README.gentoo-${SLOT} also. Usually called at src_install phase.
readme.gentoo_print_elog
Print elog messages with "${T}"/README.gentoo contents. They will be shown only when package is installed at first time. Usually called at pkg_postinst phase.

If you want to show them always, please set FORCE_PRINT_ELOG to a non empty value in your ebuild before this function is called. This can be useful when, for example, DOC_CONTENTS is modified, then, you can rely on specific REPLACING_VERSIONS handling in your ebuild to print messages when people update from versions still providing old message.

readme.gentoo_src_install
Install generated doc file automatically.
readme.gentoo_pkg_postinst
Show elog messages from from just generated doc file.
 

ECLASS VARIABLES

DISABLE_AUTOFORMATTING
If non-empty, DOC_CONTENTS information will be strictly respected, not getting it automatically formatted by fmt. If empty, it will rely on fmt for formatting and 'echo -e' options to tweak lines a bit.
FORCE_PRINT_ELOG
If non-empty this variable forces elog messages to be printed.
 

AUTHORS

Author: Pacho Ramos <pacho@gentoo.org>
 

MAINTAINERS

Pacho Ramos <pacho@gentoo.org>
 

REPORTING BUGS

Please report bugs via http://bugs.gentoo.org/  

FILES

/usr/portage/eclass/readme.gentoo  

SEE ALSO

ebuild(5)
http://sources.gentoo.org/eclass/readme.gentoo?view=log


 

Index

NAME
FUNCTIONS
ECLASS VARIABLES
AUTHORS
MAINTAINERS
REPORTING BUGS
FILES
SEE ALSO

This document was created by man2html, using the manual pages.
Time: 03:25:10 GMT, April 23, 2014