* Document eblank and eqawarn in the ebuild.5 man page.

* Create "Ebuild Helper Functions" section docbook format,
  including all the functions documented in the ebuild.5
  man page.
(trunk r10687)

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

diff --git a/doc/package/ebuild.docbook b/doc/package/ebuild.docbook
index 5466f99db38669a5fa8bcb9907b78221bec7de52..4bdb8129d92bb8cc08456f5ecbb951960194b144 100644 (file)
--- a/doc/package/ebuild.docbook
+++ b/doc/package/ebuild.docbook
@@ -1,4 +1,5 @@
 <chapter id='package-ebuild'>
 <title>Ebuild</title>
 &package_ebuild_phases;
+&package_ebuild_helper_functions;
 </chapter>

diff --git a/doc/portage.docbook b/doc/portage.docbook
index 063fcc36c3f198e75cf5cb6f6479a996b9633bfa..343a8058c8a446ab1d095deff052d85058351824 100644 (file)
--- a/doc/portage.docbook
+++ b/doc/portage.docbook
@@ -14,6 +14,7 @@
        <!ENTITY package SYSTEM "package.docbook">
        <!ENTITY package_ebuild SYSTEM "package/ebuild.docbook">
        <!ENTITY package_ebuild_phases SYSTEM "package/ebuild/phases.docbook">
+       <!ENTITY package_ebuild_helper_functions SYSTEM "package/ebuild/helper_functions.docbook">
        <!ENTITY qa SYSTEM "qa.docbook">
        <!ENTITY config SYSTEM "config.docbook">
        <!ENTITY config_bashrc SYSTEM "config/bashrc.docbook">

diff --git a/man/ebuild.5 b/man/ebuild.5
index 9885175ccc39a56f6689919be24f65a380d29bd0..7d544a75d547da297740c4bfae97bcb84a293898 100644 (file)
--- a/man/ebuild.5
+++ b/man/ebuild.5
@@ -580,6 +580,10 @@ VERINS="$(best_version net\-ftp/glftpd)"
 .RE
 .SH "HELPER FUNCTIONS: OUTPUT"
 .TP
+\fBeblank\fR
+Show a blank line. Consecutive eblank calls collapse into
+a single blank line.
+.TP
 \fBeinfo\fR \fI"disposable message"\fR
 Same as \fBelog\fR, but should be used when the message isn't important to the
 user (like progress or status messages during the build process).
@@ -593,6 +597,9 @@ will also be logged by portage for later review.
 \fBewarn\fR \fI"warning message"\fR
 Same as \fBeinfo\fR, but should be used when showing a warning to the user.
 .TP
+\fBeqawarn\fR \fI"QA warning message"\fR
+Same as \fBeinfo\fR, but should be used when showing a QA warning to the user.
+.TP
 \fBeerror\fR \fI"error message"\fR
 Same as \fBeinfo\fR, but should be used when showing an error to the user.
 .TP