From: Zac Medico <zmedico@gentoo.org>
Date: Tue, 17 Jun 2008 07:47:59 +0000 (-0000)
Subject: * Document eblank and eqawarn in the ebuild.5 man page.
X-Git-Tag: v2.1.5.6~4
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=33e7603052e8a7a27c925a74b5c9ce42524cba90;p=portage.git

* 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 5466f99db..4bdb8129d 100644
--- 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 063fcc36c..343a8058c 100644
--- 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 9885175cc..7d544a75d 100644
--- 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