From 777e3a30848090143e8a06a36aaa9267ad5df3db Mon Sep 17 00:00:00 2001 From: Zac Medico Date: Tue, 17 Jun 2008 07:49:31 +0000 Subject: [PATCH] Add missing helper_functions.docbook from previous commit. svn path=/main/branches/2.1.2/; revision=10689 --- doc/package/ebuild/helper_functions.docbook | 57 +++++++++++++++++++++ 1 file changed, 57 insertions(+) create mode 100644 doc/package/ebuild/helper_functions.docbook diff --git a/doc/package/ebuild/helper_functions.docbook b/doc/package/ebuild/helper_functions.docbook new file mode 100644 index 000000000..ab83d4ed1 --- /dev/null +++ b/doc/package/ebuild/helper_functions.docbook @@ -0,0 +1,57 @@ + + Helper Functions + + Output + + ebegin + + Like einfo, we output a helpful message and then hint that the following + operation may take some time to complete. Once the task is finished, you + need to call eend. + + + + eblank + + Show a blank line. Consecutive eblank calls collapse into + a single blank line. + + + + eend + + Followup the ebegin message with an appropriate "OK" or "!!" (for errors) + marker. If status is non-zero, then the additional error message is + displayed. + + + + einfo + + Same as elog, but should be used when the message isn't important + to the user (like progress or status messages during the build process). + + + + elog + + If you need to display a message that you wish the user to read + and take notice of, then use elog. It works just like echo(1), + but adds a little more to the output so as to catch the user's eye. + The message will also be logged by portage for later review. + + + + eqawarn + + Same as einfo, but should be used when showing a QA warning to the user. + + + + ewarn + + Same as einfo, but should be used when showing a warning to the user. + + + + -- 2.26.2