Add missing helper_functions.docbook from previous commit.

svn path=/main/branches/2.1.2/; revision=10689

diff --git a/doc/package/ebuild/helper_functions.docbook b/doc/package/ebuild/helper_functions.docbook
new file mode 100644 (file)
index 0000000..ab83d4e
--- /dev/null
+++ b/doc/package/ebuild/helper_functions.docbook
@@ -0,0 +1,57 @@
+<sect1 id='package-ebuild-helper-functions'>
+       <title>Helper Functions</title>
+       <sect2 id='package-ebuild-helper-functions-output'>
+       <title>Output</title>
+       <sect3 id='package-ebuild-helper-functions-output-ebegin'>
+       <title>ebegin</title>
+       <para>
+       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.
+       </para>
+       </sect3>
+       <sect3 id='package-ebuild-helper-functions-output-eblank'>
+       <title>eblank</title>
+       <para>
+       Show a blank line. Consecutive eblank calls collapse into
+       a single blank line.
+       </para>
+       </sect3>
+       <sect3 id='package-ebuild-helper-functions-output-eend'>
+       <title>eend</title>
+       <para>
+       Followup the ebegin message with an appropriate "OK" or "!!" (for errors)
+       marker. If status is non-zero, then the additional error message is
+       displayed.
+       </para>
+       </sect3>
+       <sect3 id='package-ebuild-helper-functions-output-einfo'>
+       <title>einfo</title>
+       <para>
+       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).
+       </para>
+       </sect3>
+       <sect3 id='package-ebuild-helper-functions-output-elog'>
+       <title>elog</title>
+       <para>
+       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.
+       </para>
+       </sect3>
+       <sect3 id='package-ebuild-helper-functions-output-eqawarn'>
+       <title>eqawarn</title>
+       <para>
+       Same as einfo, but should be used when showing a QA warning to the user.
+       </para>
+       </sect3>
+       <sect3 id='package-ebuild-helper-functions-output-ewarn'>
+       <title>ewarn</title>
+       <para>
+       Same as einfo, but should be used when showing a warning to the user.
+       </para>
+       </sect3>
+       </sect2>
+</sect1>