]> Kevux Git Server - fll/commitdiff
Update: add missing documentation for fake fakefile fail setting.
authorKevin Day <thekevinday@gmail.com>
Sat, 18 Jul 2020 05:08:58 +0000 (00:08 -0500)
committerKevin Day <thekevinday@gmail.com>
Sun, 19 Jul 2020 03:30:48 +0000 (22:30 -0500)
level_3/fake/documents/fakefile.txt
level_3/fake/specifications/fakefile.txt

index 9ec2842734a4e4bb51674fd9aeb9c04c4d4f579d..17b1138f25d1d7b3ac9d09e180d7e1b703ea77f2 100644 (file)
@@ -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.
index 0a466c72888980b2b75435c3a771cbde0178a373..b8bf101fff2e5844a7a469bd5e9fa73c408ccbad 100644 (file)
@@ -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.