From 4d202bebfd9bb0f88d722cc8c75ff7e1e375ea28 Mon Sep 17 00:00:00 2001 From: Kevin Day Date: Sat, 18 Jul 2020 00:08:58 -0500 Subject: [PATCH] Update: add missing documentation for fake fakefile fail setting. --- level_3/fake/documents/fakefile.txt | 10 ++++++++++ level_3/fake/specifications/fakefile.txt | 1 + 2 files changed, 11 insertions(+) diff --git a/level_3/fake/documents/fakefile.txt b/level_3/fake/documents/fakefile.txt index 9ec2842..17b1138 100644 --- a/level_3/fake/documents/fakefile.txt +++ b/level_3/fake/documents/fakefile.txt @@ -19,6 +19,16 @@ Fakefile Documentation: The environment variable name is case-sensitive. This replaces the value of any existing environment variable with this name. + - fail\: + Designates the fail mode when running external programs, such as through the "run" or "shell" operations. + + There are three options: + - exit: Designates to exit the program on failure, printing an error message. + - warn: Designates to continue on and if in verbose mode then print a warning. + - ignore: Designates to do nothing. + + The return code for programs can still be retrieved through using the reserved iki vaiable "return". + - load_build\: This represents whether or not to load the load the build settings file. The first Content value may be "true" to load the build settings and "false" to not load the build settings file. diff --git a/level_3/fake/specifications/fakefile.txt b/level_3/fake/specifications/fakefile.txt index 0a466c7..b8bf101 100644 --- a/level_3/fake/specifications/fakefile.txt +++ b/level_3/fake/specifications/fakefile.txt @@ -34,6 +34,7 @@ Fakefile Specification: The Settings Objects are\: - define: First Content represents variable name (case-sensitive), remaining Content represents varaiable value for IKI substitution. + - fail: Only one Content, which must be either "exit", "warn" or "ignore" (quotes not required) (case-sensitive). - load_build: Only one Content, which must be either "yes" or "no" (quotes not required) (case-sensitive). - parameter: First Content represents variable name (case-sensitive), remaining Content represents varaiable value for IKI substitution. -- 1.8.3.1