aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorUlrich Müller <ulm@gentoo.org>2020-02-08 20:43:23 +0100
committerUlrich Müller <ulm@gentoo.org>2020-02-11 12:38:00 +0100
commit3b8fa72d91bbdd08aa08f7e7bf0ca66833095186 (patch)
treeac5d3a0407786a7c860d006d1f50d934647ec504 /function-reference/error-functions
parentMakefile: Remove quirks necessary for installing in-place. (diff)
downloaddevmanual-3b8fa72d91bbdd08aa08f7e7bf0ca66833095186.tar.gz
devmanual-3b8fa72d91bbdd08aa08f7e7bf0ca66833095186.tar.bz2
devmanual-3b8fa72d91bbdd08aa08f7e7bf0ca66833095186.zip
ebuild-writing/eapi: Move EAPI=4 information to other sections.
- Utilities die, nonfatal: New section in ebuild-writing/error-handling, new chapter function-reference/error-functions - dodoc -r: Already in function-reference/install-functions, add additional example to ebuild-writing/functions/src_install - doins symlink support: Incorporated into function-reference/install-functions - dosed, dohard banned: Not mentioned anywhere else - econf --disable-dependency-tracking: New section about econf options in ebuild-writing/functions/src_configure/configuring - Controllable compression and docompress: New chapter ebuild-writing/functions/src_install/docompress - USE dependency defaults: Incorporated into general-concepts/dependencies - pkg_pretend: Already in ebuild-writing/functions/pkg_pretend - default src_install: Already in ebuild-writing/functions/src_install - pkg_info: Incorporated into ebuild-writing/functions/pkg_info - REQUIRED_USE: Already in ebuild-writing/variables - MERGE_TYPE, REPLACING_VERSIONS, REPLACED_BY_VERSION: Moved to ebuild-writing/variables - DOCS: Incorporated into ebuild-writing/variables - AA, KV removed: Not mentioned anywhere else - RDEPEND=DEPEND: Already handled in commit 5a946b4 Signed-off-by: Ulrich Müller <ulm@gentoo.org>
Diffstat (limited to 'function-reference/error-functions')
-rw-r--r--function-reference/error-functions/text.xml50
1 files changed, 50 insertions, 0 deletions
diff --git a/function-reference/error-functions/text.xml b/function-reference/error-functions/text.xml
new file mode 100644
index 0000000..70153eb
--- /dev/null
+++ b/function-reference/error-functions/text.xml
@@ -0,0 +1,50 @@
+<?xml version="1.0"?>
+<guide self="function-reference/error-functions/">
+<chapter>
+<title>Error Functions Reference</title>
+<body>
+
+<p>
+The following functions are provided by the package manager for error handling.
+</p>
+
+<table>
+ <tr>
+ <th>Function</th>
+ <th>Details</th>
+ </tr>
+ <tr>
+ <ti><c>die</c></ti>
+ <ti>
+ <p>
+ Displays an error message provided in its argument, and aborts the build
+ process.
+ </p>
+ <p>
+ In EAPI 6 and later, <c>die</c> can be called under the <c>nonfatal</c>
+ command and with the <c>-n</c> option, in which case it will not abort
+ the build process, but return with non-zero status.
+ </p>
+ </ti>
+ </tr>
+ <tr>
+ <ti><c>assert</c></ti>
+ <ti>
+ Checks the value of the <c>PIPESTATUS</c> array, and calls <c>die</c>
+ if any of its component is non-zero (which indicates failure of the
+ preceding command pipeline).
+ </ti>
+ </tr>
+ <tr>
+ <ti><c>nonfatal</c></ti>
+ <ti>
+ Takes another command as its argument and executes it. If the command
+ fails and would normally die, it returns with non-zero status instead
+ when called under <c>nonfatal</c>.
+ </ti>
+ </tr>
+</table>
+
+</body>
+</chapter>
+</guide>