Featureless Make Fakefile Specification

+ +

+ The fakefile file follows the FSS-0005 (Somewhat Basic List) format with a sub-format of IKI-0002 (Simple Script). +

+ A fakefile is broken up into multiple Basic Lists, referred to as Sections, with two special purpose reserved Sections. +

+ The Sections are broken up into multiple Extended Objects and their respective Contents, referred to as Section Operations. +

+ Each of these non-reserved Sections acts as a set to perform some set of Section Operations. +

+ Each of these Section Operations perform a single command or action based on a set of reserved Section Operation types. +

+ Each of these Section Operations have a set of Arguments associated with them. +

+ How these Arguments are interpreted and processed are specific to each Operation type. +

+ The Section Operations are represented by the Extended Object name and the Extended Content represents the Operation Arguments. +

+ Each of these Section Operations support IKI variable substitution within their respective Arguments. +

+ The Operation Extended Object does not support IKI variable substitution. +

+ The reserved Settings Section does not support IKI variable substitution. +

+ The IKI-0002 (Simple Script) vocabulary context is further clarified as follows: +

context: The value is case-sensitive variable name.
define: The value must be a case-sensitive valid environment variable name (alpha-numeric or underscore, but no leading digits).
+
parameter: The value is a case-sensitive variable name.
+
- Many parameters also support :option and :value appended at the end of the value.
+

+ The reserved Section Objects are: +

settings: contains a list of Settings Objects and Content in FSS-0001 (Extended) format.
main: contains a list of Operation Objects and Content in FSS-0001 (Extended) format.

+ The Settings Objects are: +

compiler: Only one Content, which must only be a valid filename.
define: First Content represents variable name (case-sensitive), remaining Content represents the value.
environment: Zero or more Content representing valid environment variable names (alpha-numeric with underscore, but cannot begin with a number).
fail: Only one Content, which must be either exit, warn or ignore (quotes not required) (case-sensitive).
indexer: Only one Content, which must only be a valid filename.
indexer_arguments: Zero or more arguments supported by the indexer specified in code:build_indexer".
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 the value.

+ The build settings may also be specified in the Settings Section. +

+ The Section Operation Objects are: +

and: One or more Content. First Content is the condition or no_dereference (when no_dereference, then the Second Content is the condition, etc..), remaining Content are specific to the condition.
break: Zero or one Content. If specified, First content must be one of success or failure.
build: Zero or more Content. First Content represents file name of the settings file to use, Second Content and on represent custom modes to use.
clean: Zero Content.
clone: Two or more Content representing paths to files.
compile: One or more Content as parameters to compiler.
copy: Two or more Content representing paths to files.
define: First Content represents variable name (case-sensitive), remaining Content represents the value.
delete: One or more Content representing paths to files.
deletes: One or more Content representing paths to files.
else: Zero Content.
exit: Zero or One Content. If specified, First content must be one of succeed or fail.
fail: One Content. First Content must be one of exit, warn, or ignore (case-sensitive).
group: Two or more Content. First Content is group name, number, or no_dereference (when no_dereference, then the second Content is the group name or number, etc..), remaining Content are paths to files.
groups: Two or more Content. First Content is group name, number, or no_dereference (when no_dereference, then the second Content is the group name or number, etc..), remaining Content are paths to files.
if: One or more Content. First Content is the condition or is no_dereference (when no_dereference, then the Second Content is the condition, etc..), remaining Content are specific to the condition.
index: One or more Content.
link: Two to Four Content. The first and second Content may be either force or strict, the second to last Content is the link target file, and the last Content is the pointer file (the link).
mode: Two or more Content. First Content is the mode, remaining Content are paths to files.
modes: Two or more Content. First Content is the mode, remaining Content are paths to files.
move: Two or more Content representing paths to files.
operate: One Content. First Content is the name of a valid Section Object, except for the reserved Section Objects.
or: One or more Content. First Content is the condition or no_dereference (when no_dereference, then the Second Content is the condition, etc..), remaining Content are specific to the condition.
owner: Two or more Content. First Content is owner name, number, or no_dereference (when no_dereference, then the second Content is the owner name or number, etc..), remaining Content are paths to files.
owners: Two or more Content. First Content is owner name, number, or no_dereference (when no_dereference, then the second Content is the owner name or number, etc..), remaining Content are paths to files.
parameter: First Content represents variable name (case-sensitive), remaining Content represents the value.
pop: Zero Content.
print: Zero or more Content.
run: One or more Content. First Content is the name of the program (or script) and all remaining Content are passed as arguments to the named program (or script).
shell: One or more Content. First Content is the file path of the program (or script) and all remaining Content are passed as arguments to the named program (or script).
skeleton: Zero Content.
to: One Content. First Content is the directory path.
top: Zero Content.
touch: Two or more Content. First Content is one of file or directory, remaining Content are paths to files.
write: One or more Content. First Content the file to write to, remaining Content represent the string to write.

+ The if Section Operation conditions are: +

==: Two or more Content.
>: Two or more Content.
<: Two or more Content.
>=: Two or more Content.
<=: Two or more Content.
<>: Two or more Content.
define: One or more Content are valid environment variable name.
exist: One or more Content representing the files to check the existence of.
failure: has no other Content.
group: First Content is the name of a group. Second or more Content are paths to files.
is: First Content is a list of block, character, no_dereference, directory, fifo, link, regular , or socket followed by "for" and then the Remaining Content that are paths to files.
mode: First Content is either has, is, or no_dereference. Second Content is a valid file mode. Third or more Content are paths to files.
no_dereference: A non-condition inserted before any of exist, is, and mode (then the second Content is the actual condition followed by any Content associated with that condition).
not: First Content is one of define, exist, group, is, mode, no_dereference, owner, or parameter and all remaining Content are based on the First Content's if Section Operation Content rules.
owner: First Content is the name of an owner. Second or more Content are paths to files.
parameter: One or more Content are valid IKI names.
success: has no other Content.

+ The if Section Operation conditions and numbers: +

+
The numbers may be represented in any of the forms:
+
1. decimal: all numbers without a base-type prefix are of base-type 10, referred to as decimal.
2. binary: all numbers with the prefix 0b (uppercase or lowercase b) are of base-type 2, referred to as binary.
3. octal: all numbers with the prefix 0o (that is zero followed by the letter o, uppercase or lowercase o) are of base-type 8, referred to as octal.
4. duodecimal: all numbers with the prefix 0d (uppercase or lowercase d) are of base-type 12, referred to as duodecimal.
5. hexadecimal: all numbers with the prefix 0x (uppercase or lowercase x) are of base-type 16, referred to as hexadecimal.
+
+ (At this time) The numbers may be of a max value of 2^64, or 18446744073709551615, positive or negative. +
+
+ (At this time) The numbers may only be whole numbers. +
+
+ Note: There are plans to impose no limits on the number size or any decimal values, but this requires significant work is not to be implemented at this time. + Once this restriction is lifted, it should be conditional upon an implementation for what the maximum supported numbers or digits may be. +
+
+ Only the following if Section Operation conditions use these operators: +
+
- >
- <
- >=
- <=
+

+ The if Section Operation condition parameter: +

The following reserved words are available for parameter names: build, color, current, data, define, fakefile, mode, process, return, settings, sources, top, verbosity, and work.
Each of the reserved words supports having :option and :value appended, such as: work:value.

+ +

Fakefile Documentation

+ +

+ This describes intent and purposes of the fakefile file settings. +

+ All files specified are relative to the project root. +

+ The reserved Section Names are defined as follows: +

+
settings:
+
+ Any configuration specific to this fakefile is stored here. +
+
+ This includes the declaration of define and parameter IKI variable substitution values. +
+
+ The build settings may also be specified in the Settings Section. +
+
+ The following settings are available (in addition to the build settings): +
+
- +
  compiler:
  +
  - +
    This represents the name of the compiler program to use, such as gcc.
    +
    + The programs gcc and clang are known to work. +
    +
    + Many of the parameters in the settings file can be changed if using a non-GCC, but there may be certain hard-coded functionality that may need to be changed. +
    +
    + When specified and load_build is true, then this will override the build_compiler specified in the loaded build settings. +
    +
  +
- +
  define:
  +
  - +
    This represents an environment variable to define on run.
    +
    + The environment variable name is case-sensitive. +
    +
    + This replaces the value of any existing environment variable with this name. +
    +
  +
- +
  environment:
  +
  - +
    This represents all environment variables that are exposed when executing sub-programs.
    +
    + This is not auto-populated for environment variables defined in the define setting. +
    +
    + When defined with no Content, then this means that no environment variables are exposed. +
    +
    + When not defined at all, then all environment variables are exposed. +
    +
    + Environment variables may still be exposed if load_build is true and the build setting file defines any environment variable names. +
    +
  +
- +
  fail:
  +
  - +
    Designates the fail mode when running external programs, such as through the run or shell operations.
    +
    + There are three options: +
    +
    1. exit: Designates to exit the program on failure, printing an error message.
    2. warn: Designates to continue on and if in verbose mode then print a warning.
    3. ignore: Designates to do nothing.
    +
    + The return code for programs can still be retrieved through using the reserved IKI vaiable return. +
    +
  +
- +
  indexer:
  +
  - +
    This represents the name of the indexer program to use, such as ar.
    +
    + An indexer is often called a linker. +
    +
    + Similar to build_compiler, any linker that supports the ar program parameters is effectively supported. +
    +
    + When specified and load_build is true, then this will override the build_indexer specified in the loaded build settings. +
    +
  +
- +
  indexer_arguments:
  +
  - +
    This represents arguments needed to build an archive file from object files, such as rcs.
    +
    + These arguments are placed immediately before the object files passed to the indexer program. +
    +
  +
- +
  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. +
    +
  +
- +
  parameter:
  +
  - +
    This defines an IKI variable name to substitute with the value.
    +
    + This replaces the value of any existing environment variable with this name. +
    +
    + The first Content value represents the IKI variable name. +
    +
    + All Content values after the first represent the values the matching IKI variable is replaced with. +
    +
    + The parameter variable name return is used to store the return result of a run or shell operation. +
    +
    + Setting this here only sets the default return parameter variable value. +
    +
  +
+
+
main:
+
+ This is the main entry point when processing the fakefile. +
+
+ This is processed top-down until the end of the list is reached. +
+
+ The following operations are available: +
+
- +
  and:
  +
  + A special type of an if operation. +
  +
  + May only be specified following a valid if, and, or or operation. +
  +
  + This is executed only if the previous if operation result is true. +
  +
  + When executed, this performs the test and returns true or false as appropriate. +
  +
  + When not executed, this passes through the result of the previous if, and, or or operation. +
  +
  +
- +
  build:
  +
  + Run the fake build operation as if fake build was run instead of fake make. +
  +
  + Command line arguments are automatically passed to the fake build operation. +
  +
  + Accepts an optional Content that is a file name to a build settings file to use instead of the default. +
  +
  + This file name is relative to the data build directory (which can be changed by -D/--data parameter). +
  +
  + If the optional file name Content is specified, then it also supports additional modes to use instead of the default mode. +
  +
  + When no additional Content after the build is specified, then the default (or program supplied) settings file and modes are used. +
  +
  + When the first Content after the build is specified as an empty string, then the default (or program supplied) settings file is used. +
  +
  + When the second Content after the build (and there is no third Content), then no modes are used. +
  +
- +
  break:
  +
  + Perform an exit from the current make operation. +
  +
  + This only exists the current depth. +
  +
  + If the depth is at the top (aka: 0), then this is identical to the exit section operation. +
  +
  + The second Content may be either 'succeed' or 'fail' to designate on whether or not to exit as success or failure. +
  +
  + When set to failure this will trigger any failure (with message), depending on the current fail state. +
  +
- +
  clean:
  +
  + Run the fake clean operation as if fake clean was run instead of fake make. +
  +
  + Command line arguments are automatically passed to the fake build operation. +
  +
- +
  clone:
  +
  + Copy all files (and directories), preserving all properties, into the last content. +
  +
  + If there are more than one file (or directory) being copied, then the final path must be a directory. +
  +
  + All Content, except last, represents the files to clone. +
  +
  + The last Content represents the destination file (or directory) to clone to. +
  +
- +
  compile:
  +
  + Execute the compiler program, such as gcc. +
  +
  + All Content are passed as arguments to the respective gcc program. +
  +
- +
  copy:
  +
  + Copy all files (and directories) into the last content. +
  +
  + If there are more than one file (or directory) being copied, then the final path must be a directory. +
  +
  + All Content, except last, represents the files to copy. +
  +
  + The last Content represents the destination file (or directory) to copy to. +
  +
- +
  define:
  +
  + This represents an environment variable to define on run. +
  +
  + The environment variable name is case-sensitive. +
  +
  + This replaces the value of any existing environment variable with this name. +
  +
- +
  delete:
  +
  + Delete one or more files or directories. +
  +
  + All Content must be the file or directory to be deleted. +
  +
  + If the path is a directory and is not empty, then this will not delete the directory. +
  +
- +
  deletes:
  +
  + Identical to delete, except that when the path is a directory and is not empty, then this will delete the directory. +
  +
- +
  else:
  +
  + Performs a programmatic else condition. +
  +
  + Must be specified following a valid if operation (and the operation it affects). +
  +
  + This has no Content. +
  +
  + An else operation may not follow this. +
  +
  + An if operation may immediately follow to represent an else if condition. +
  +
- +
  exit:
  +
  + Perform an exit from the entire make operation. +
  +
  + This always exits completely, regardless of the operation depth. +
  +
  + The second Content may be either 'success' or 'failure' to designate on whether or not to exit as success or failure. +
  +
  + When set to failure this will trigger a failure message. +
  +
  + When set to failure, the fail state will be forcibly changed to fail regardless of the current fail state. +
  +
- +
  fail:
  +
  + Toggle how the to handle an operation failure. +
  +
  + The first Content may be one of the following: +
  +
  - exit: Set failure handler to exit on failure.
  - warn: Set failure handler to print a warning on failure but continue on.
  - ignore: Set failure handler to continue on regardless of failure.
  +
- +
  group:
  +
  + Change the group role for a given file. +
  +
  + The first Content represents the group to assign. +
  +
  + The second Content represents the file to assign the group to. +
  +
- +
  groups:
  +
  + Identical to group operation, except this will recursively apply the mode to all files within the given file, if that file is a directory file path. +
  +
- +
  if:
  +
  + Performs a programmatic if condition. +
  +
  + May be specified following a valid else operation. +
  +
  + The Content represents a set of conditions to perform. +
  +
  + The if operation may be used in conjunction with the and, or, and the else operations. +
  +
  + The conditional logic is different from normal logic found in most software programs. +
  +
  + There is only one order of operation, a top-down design where the current operation relates to the previous operation. +
  +
  + This is mostly relevant when if operation is followed by an and or an or operation. +
  +
  + Consider the following: +
```
+if parameter xxx
+or parameter yyy
+and parameter zzz
+  print first
+else
+if parameter www
+  print second
+else
+  print third
+
```
  +
  + The resulting logic is as follows: +
  +
  1. If xxx is defined, then...
  2. If result from (1) is TRUE or if yyy is defined, then...
  3. If result from (2) is TRUE and if zzz is defined, then...
  4. If result from (3) is FALSE, then...
  5. If result from (4) is TRUE, then...
  6. If result from (5) is FALSE, then...
  +
  + For all conditions that rely on numbers, only whole numbers are (currently) supported. +
  +
  + conditions: +
  +
  - +
    == "left" "right":
    +
    + Compare all parameters to be equal. +
    +
    + Requires 2 or more after the ==. +
    +
    + For example, if == 'a' 'b' 'c' 'd' would test: 'a' == 'b' && 'b' == 'c' && 'c' == 'd'. +
    +
    + This performs only string-based comparisons. +
    +
  - +
    > "left string" "right string":
    +
    + Compare left to right for greater than. +
    +
    + Requires 2 or more after the >. +
    +
    + For example, if > 0 1 2 3 would test: 0 > 1 && 1 > 2 && 2 > 3. +
    +
    + This performs only number-based comparisons. +
    +
  - +
    < "left string" "right string":
    +
    + Compare left to right for less than. +
    +
    + Requires 2 or more after the >. +
    +
    + For example, if < 0 1 2 3 would test: 0 < 1 && 1 < 2 && 2 < 3. +
    +
    + This performs only number-based comparisons. +
    +
  - +
    >= "left string" "right string":
    +
    + Compare left to right for greater than or equal to. +
    +
    + Requires 2 or more after the >=. +
    +
    + For example, if >= 0 1 2 3 would test: 0 >= 1 && 1 >= 2 && 2 >= 3. +
    +
    + This performs only number-based comparisons. +
    +
  - +
    <= "left string" "right string":
    +
    + Compare left to right for less than or equal to. +
    +
    + Requires 2 or more after the >=. +
    +
    + For example, if <= 0 1 2 3 would test: 0 <= 1 && 1 <= 2 && 2 <= 3. +
    +
    + This performs only number-based comparisons. +
    +
  - +
    <> "left" "right":
    +
    + Compare all parameters to be not equal. +
    +
    + Requires 2 or more after the ==. +
    +
    + For example, if <> 'a' 'b' 'c' would test: 'a' <> 'b' && 'b' <> 'c' && 'a' <> 'c'. +
    +
    + This performs only string-based comparisons. +
    +
  - +
    define "some define name":
    +
    + Test if one or more names are defined as an environment variable. +
    +
    + For example, if define PWD SHELL would test if both the PWD and the SHELL variables are defined via the environment variables. +
    +
  - +
    exist "file path":
    +
    + Test if file exists. +
    +
    + For example, if exist "a.txt" "b.txt" would test if both the file a.txt and b.txt exist. +
    +
  - +
    failure:
    +
    + Test if the previous section operation failed. +
    +
  - +
    group "some mode" "some file":
    +
    + For example, if group friends a.txt b.txt would test if both file a.txt and b.txt have a group named we. +
    +
  - +
    is block character directory fifo link regular socket for "file path":
    +
    + Test if one or more files exist and if each file is any of the given types. +
    +
    + The given types must be followed by for to designate where the the file paths begin. +
    +
    + For example, if is regular directory for "a.txt" "b.txt" would test if both the file a.txt and b.txt exist and are either of type regular or type directory. +
    +
  - +
    mode is/has "some mode" "some file":
    +
    + Test if one or more files has the exact mode (is) or has at least the given modes (has). +
    +
    + For example, if mode is u+r a.txt b.txt would test if both file a.txt and b.txt only have owner set to read. +
    +
    + For example, if mode has u+r a.txt b.txt would test if both file a.txt and b.txt has owner set to read, and all other modes can be anything. +
    +
  - +
    not:
    +
    + Perform the test expecting a false result rather than a true result. +
    +
    + This is to be immediately followed by a valid if condition as well as all appropriate valid content associated with that if condition. +
    +
    + Only the following if conditions are supported: +
    +
    - define.
    - exist.
    - group.
    - is.
    - mode.
    - owner.
    - parameter.
    +
    + Examples: +
    +
    - if not parameter work
    - if not exist documentation.txt
    +
  - +
    owner "some mode" "some file":
    +
    + Test if one or more files has the given owner. +
    +
    + For example, if owner me a.txt b.txt would test if both file a.txt and b.txt have an owner named me. +
    +
  - +
    parameter "some parameter name":
    +
    + Test if one or more names are defined as a parameter variable. +
    +
    + For example, if parameter verbose silent would test if both the verbose and the silent variables are defined via the parameter setting. +
    +
    + Reserved parameters that represent program arguments, three forms are available. +
    +
    + For example, the program argument -w/--work has the reserved word work and has three forms: +
    +
    1. work.
    2. work:option.
    3. work:value.
    +
    + In the case of form 1, the if parameter work would be true if the argument is passed to the program or a default is provided. +
    +
    + In the case of form 2, the if parameter work:option would be true if the argument is passed to the program. +
    +
    + In the case of form 3, the if parameter work:value would be true if the argument is passed to the program and has a non-zero value. +
    +
    + Some reserved parameters, such as the verbosity, has no value and in this case would always return false for if parameter verbosity:value. +
    +
    + The following are reserved parameters: +
    +
    - build: Associated with -b/--build parameter.
    - color: Associated with +d/++dark, +l/++light, and +n/++no_color parameters.
    - current: The absolute path to the current working directory (present working directory) (Always has a trailing forward slash).
    - data: Associated with -D/--data parameter.
    - define: Associated with -d/--define parameter.
    - fakefile: Associated with -f/--fakefile parameter.
    - mode: Associated with -m/--mode parameter and possibly with the build settings default mode modes_default.
    - process: Associated with -p/--process parameter.
    - return: Contains the return value of a previous operation that produces a return code.
    - settings: Associated with -s/--settings parameter.
    - sources: Associated with -S/--sources parameter.
    - top: The absolute path to the top directory, which is the base project directory (Always has a trailing forward slash).
    - verbosity: Associated with +Q/++quiet, +E/++error, +N/++normal, +V/++verbose, and +D/++debug parameters.
    - work: Associated with -w/--work parameter.
    +
  - +
    succeed:
    +
    - Test if the previous section operation succeeded.
    +
  +
- +
  index:
  +
  + Execute the linker program, such as ar. +
  +
  + All Content are passed as arguments to the respective ar program. +
  +
- +
  link:
  +
  + Create a symbolic link from some point to some target. +
  +
  + The first Content, when there are more than 2 arguments, may be either force or strict. +
  +
  + The second to last Content represents the target file. +
  +
  + The last Content represents the point file. +
  +
  + The force Content designates that the point file will be overwritten if the file already exists. +
  +
  + The strict Content requires that the target file already exists. +
  +
- +
  mode:
  +
  + Change the mode permissions for a given file. +
  +
  + The first Content represents the mode to assign. +
  +
  + The second Content represents the file to assign the mode to. +
  +
- +
  modes:
  +
  + Identical to mode operation, except this will recursively apply the mode to all files within the given file, if that file is a directory file path. +
  +
- +
  move:
  +
  + Move all files (and directories) into the last content. +
  +
  + If there are more than one file (or directory) being copied, then the final path must be a directory. +
  +
  + All Content, except last, represents the files to move. +
  +
  + The last Content represents the destination file (or directory) to move to. +
  +
- +
  operate:
  +
  + Begin execution of another Section. +
  +
  + The first Content represents the name of the Section Object to execute. +
  +
  + This may be neither the settings Section no the main Section. +
  +
  + Recursion is prohibited, a Section that is already on the operation stack may not be called again. +
  +
  + Once the operation is off the stack, it can then be called again. +
  +
- +
  or:
  +
  + A special type of an if operation. +
  +
  + May only be specified following a valid if, and, or or operation. +
  +
  + This is executed only if the previous if operation result is false. +
  +
  + When executed, this performs the test and returns true or false as appropriate. +
  +
  + When not executed, this passes through the result of the previous if, and, or or operation. +
  +
- +
  owner:
  +
  + Change the owner role for a given file. +
  +
  + The first Content represents the role to assign. +
  +
  + The second Content represents the file to assign the role to. +
  +
- +
  owners:
  +
  + Identical to owner operation, except this will recursively apply the mode to all files within the given file, if that file is a directory file path. +
  +
- +
  parameter:
  +
  + This represents a variable defined within the scope of the fakefile. +
  +
  + This is not exported as an environment variable and is therefore not visible to any executed programs or scripts. +
  +
  + This replaces the value of any existing parameter variable with this name. +
  +
  + The reserved parameter variable names (see IKI vocabulary context section below) may not be changed by this. +
  +
- +
  pop:
  +
  + Pop a directory path of the path stack, thereby changing to the previous directory on the stack. +
  +
  + This is a change directory command similar to a back button in a browser. +
  +
  + This has no Content. +
  +
  + This does not generate an error if the path stack is empty. +
  +
  + If the directory popping to no longer exists, then an error occurs. +
  +
- +
  print:
  +
  + Print the content to the output screen. +
  +
  + This always prints a newline at the end. +
  +
  + All Content is printed, and if no Content is provided, an empty line is printed. +
  +
  + The following escape sequences are supported for printing special characters: +
  +
  - \f: Form Feed.
  - \n: New Line.
  - \r: Carriage Return.
  - \t: Tab.
  - \v: Vertical Tab.
  - \: Backslash Character (may require additional slashes in certain circumstances.)
  - \0: NULL Character.
  - \U+: Unicode Sequence (followed by a valid Unicode sequence with a minimum 4 hexidecimal digits and a maximum of 6 hexidecimal digits).
  - \!: Non-printing separator, allowing for \U+000A\!5 to be equivalent to \n5.
  +
  + If the Unicode is invalid, then nothing is printed for that character (the invalid character is skipped when printing). +
  +
  + Example Unicodes: +
  +
  - \U+000A: Prints a new line, equivalent to \n.
  - \U+2E19: Prints the Unicode feather-like character â¸.
  +
  + Only ASCII alpha-numeric hexidecimal digits are allowed in the Unicode sequence (upper or lower case). +
  +
  + Invalid or unknown escape sequences are not printed. +
  +
- +
  run:
  +
  + Manually execute a remote program or script. +
  +
  + This program must be in the appropriate PATH environment or otherwise automatically detected when calling without a specific path to the program or script. +
  +
  + The first Content represents the program or script name. +
  +
  + All Content after the first are passed to the program or script when running. +
  +
  + After this executes the return result is made available via the return parameter variable name. +
  +
  + Any existing value associated with return gets replaced. +
  +
- +
  shell:
  +
  + Manually execute a remote program or script using a specific path to the program or script. +
  +
  + This does not require the program to exist in PATH, but the path to the program or script must be relative to the project path. +
  +
  + The first Content represents the program or script name. +
  +
  + All Content after the first are passed to the program or script when running. +
  +
  + After this executes the return result is made available via the return parameter variable name. +
  +
  + Any existing value associated with return gets replaced. +
  +
- +
  skeleton:
  +
  + Run the fake skeleton operation as if fake skeleton was run instead of fake make. +
  +
  + Command line arguments are automatically passed to the fake skeleton operation. +
  +
- +
  to:
  +
  + Change to the directory within the project root path tree, pushing the previous directory onto the path stack. +
  +
  + The previous path is saved onto the path stack and may later be popped off. +
  +
  + The first Content represents the path to change directory into. +
  +
- +
  top:
  +
  + Change to the project root path, clearing the directory path stack. +
  +
  + This has no Content. +
  +
  + If the project root path no longer exists, then an error occurs. +
  +
- +
  touch:
  +
  + Manually create a new file or a directory within the project root or update its last changed timestamp if the file already exists. +
  +
  + The first Content must be either file or directory. +
  +
  + The remaining Content must be a path to the file. +
  +
- +
  write:
  +
  + Write strings to a file within the project root. +
  +
  + The Content after the first Content is appended to the file. +
  +
  + The first Content represents the file to write to. +
  +
  + If there is no Content beyond the first, then the file is truncated (all content within the file is deleted). +
  +
  + In all cases, if the file does not exist, the file is created. +
  +
  + When only the first Content exists, this acts similar to the touch operation. +
  +
  + The major difference between the two is that the touch operation does not alter the content within the file. +
  +
  + This does alter the content within the file. +
  +
  + A single space is printed between each argument. +
  +
  + To preserve spaces, wrap the message in quotes (single or double). +
  +
  + The following escape sequences are supported for printing special characters: +
  +
  - \f: Form Feed.
  - \n: New Line.
  - \r: Carriage Return.
  - \t: Tab.
  - \v: Vertical Tab.
  - \: Backslash Character (may require additional slashes in certain circumstances.)
  - \0: NULL Character.
  - \U+: Unicode Sequence (followed by a valid Unicode sequence with a minimum 4 hexidecimal digits and a maximum of 6 hexidecimal digits).
  - \!: Non-printing separator, allowing for \U+000A\!5 to be equivalent to \n5.
  +
+
+ The IKI vocabulary context is supported and is further clarified as follows: +
+
- +
  context:
  +
  - +
    The context Object represents a name representing simple context or complex combination of context.
    +
    + Context should wrap some text such that if some text begins with some context, the context should be reset at the end. +
    +
    + The most basic context is color context, such as: context:"notice" This is emphasized text context:"reset". +
    +
    + The use of IKI in this way is acceptable but it is not perfect. +
    +
    + IKI is not designed to be a replacement to markup. +
    +
    + The markup <strong>Example</strong> vs the IKI context:"notable" Example context:"notable" has obvious differences in the spaces. +
    +
    + The IKI by design cannot be used like this: context:"notable"Examplecontext:"notable" because the word Example and the word context collide. +
    +
    + This context will respect the programs ++light, ++dark, and ++no_color parameters. +
    +
    + The following context are available: +
    +
    - error: Designate as an error, often printed in red.
    - important: Designate as important.
    - normal: Explicitly designate normal text.
    - notable: Designate as notable (similar to strong or bold in HTML).
    - reset: Remove the context.
    - standout: Designate to make notable (similar to italic or emphasis in HTML).
    - success: Designate as a success, often printed in bright green.
    - title: Designate as a title.
    - warning: Designate as a warning, often printed in some shade of orange.
    +
  +
- +
  define:
  +
  + The define Object represents environment variables passed to the program or created by the program. +
  +
  + The value represents the environment variable name and is case-sensitive. +
  +
  + This IKI variable gets substituted with the environment variable's value or NULL if not defined. +
  +
  + The settings list supports declaring custom environment variables (which overwrite any existing environment variable with the same name). +
  +
- +
  parameter:
  +
  + The parameter Object represents a variable that is to be substituted. +
  +
  + The value represents the variable name and is case-sensitive. +
  +
  + This IKI variable gets substituted with the value defined in the settings list or NULL if not defined. +
  +
  + The value may contain an additional :option or :value at the end of the name to designate getting only part of the parameter. +
  +
  + The following are reserved parameter variable names: +
  +
  - +
    build:
    +
    + This variable holds the build program parameters, such as -b build/. +
    +
    + This supports both :option and :value. +
    +
  - +
    color:
    +
    + This variable holds the color related program parameters, such as +n. +
    +
    + This supports both :option and :value (value is always an empty string). +
    +
  - +
    data:
    +
    + This variable holds the data program parameters, such as -D data/. +
    +
    + This supports both :option and :value. +
    +
  - +
    define:
    +
    + This variable holds the data program parameters, such as -d define/. +
    +
    + This supports both :option and :value. +
    +
  - +
    fakefile:
    +
    + This variable holds the fakefile program parameters, such as -f fakefile. +
    +
    + This supports both :option and :value. +
    +
  - +
    mode:
    +
    + This variable holds the fakefile program parameters, such as -m monolithic. +
    +
    + This supports both :option and :value. +
    +
  - +
    process:
    +
    + This variable holds the process program parameters, such as -p process_name. +
    +
    + This supports both :option and :value. +
    +
  - +
    return:
    +
    + This variable holds the return status from a previously run user-space applications, which happens with the run and shell section operations. +
    +
    + This does not represent the return code for each line, just only those lines that run user-space applications. +
    +
  - +
    settings:
    +
    + This variable holds the settings program parameters, such as -s settings. +
    +
    + This supports both :option and :value. +
    +
  - +
    sources:
    +
    + This variable holds the data program parameters, such as -S sources/. +
    +
    + This supports both :option and :value. +
    +
  - +
    verbosity:
    +
    + This variable holds the verbosity related program parameters, such as +V. +
    +
    + This supports both :option and :value (value is always an empty string). +
    +
  - +
    work:
    +
    + This variable holds the work program parameters, such as -w work/. +
    +
    + This supports both :option and :value. +
    +
    + An example of getting just the :option or :value part of a parameter for the work parameters: +
    +
    - +
      work:option:
      +
      +
      + This variable holds the option part of the work program parameters, such as -w. +
      +
    - +
      work:value:
      +
      + This variable holds the value part of the work program parameters, such as work/. +
      +
    +
  +
+
+ The Content no_dereference may be specified in certain cases relating to files. + These cases operate on a file that can be a link itself or the link target. + The default behavior is normally to dereference the link target. +
+
+ For example, consider a symbolic link, called some_file, that points to a file that does not exist (which means that the link in question is a broken link). + The Operation if exist some_file would return false. + The Operation if no_dereference exist some_file would return true. + This is because the symbolic link itself, some_file, does exist but the file it is pointing to does not. + The no_dereference is ignored for conditions that do not need it. +
+

Featureless Make Settings Specification

+ +

+ The build settings settings file follows the FSS-0001 (Extended) format. +

+ Each Object represents a settings property name. +

+ There is only a distinct set of setting property names (see below). +

+ Each Content represents the values associated with that property. +

+ Additional restrictions are applied to each Content depending on each specific Object name (see below). +

+ Object Names and their respective Content purpose/restrictions: +

build_compiler: Must only be a valid filename.
build_indexer: Must only be a valid filename.
build_indexer_arguments: Zero or more arguments supported by the indexer specified in build_indexer.
build_language: Must only be one of: bash, c, or c++.
build_libraries: Must only contain any number of valid library include arguments that are valid for the compiler defined in "build_compiler" Object.
build_libraries_shared: Must only contain any number of valid library include arguments that are valid for the compiler defined in "build_compiler" Object.
build_libraries_static: Must only contain any number of valid library include arguments that are valid for the compiler defined in "build_compiler" Object.
build_name: Must only contain characters allowed in a filename.
build_objects_library: Must only contain any number of valid object file names relative to the appropriate path_object_* path.
build_objects_library_shared: Must only contain any number of valid object file names relative to the path_object_shared path.
build_objects_library_static: Must only contain any number of valid object file names relative to the path_object_static path.
build_objects_program: Must only contain any number of valid object file names relative to the appropriate path_object_* path.
build_objects_program_shared: Must only contain any number of valid object file names relative to the path_object_shared path.
build_objects_program_static: Must only contain any number of valid object file names relative to the path_object_static path.
build_script: Must only one of: yes or no.
build_shared: Must only one of: yes or no.
build_sources_headers: Must only contain any number of valid filenames.
build_sources_headers_shared: Must only contain any number of valid filenames.
build_sources_headers_static: Must only contain any number of valid filenames.
build_sources_library: Must only contain any number of valid filenames.
build_sources_library_shared: Must only contain any number of valid filenames.
build_sources_library_static: Must only contain any number of valid filenames.
build_sources_object: Must only contain any number of valid filenames.
build_sources_object_shared: Must only contain any number of valid filenames.
build_sources_object_static: Must only contain any number of valid filenames.
build_sources_program: Must only contain any number of valid filenames.
build_sources_program_shared: Must only contain any number of valid filenames.
build_sources_program_static: Must only contain any number of valid filenames.
build_sources_script: Must only contain any number of valid filenames.
build_sources_setting: Must only contain any number of valid filenames.
build_static: Must only one of: yes or no.
defines: Must only contain any number of valid macro names supported by the compiler specified in build_compiler.
defines_library: Must only contain any number of valid macro names supported by the compiler specified in build_compiler.
defines_library_shared: Must only contain any number of valid macro names supported by the compiler specified in build_compiler.
defines_library_static: Must only contain any number of valid macro names supported by the compiler specified in build_compiler.
defines_object: Must only contain any number of valid macro names supported by the compiler specified in build_compiler.
defines_object_shared: Must only contain any number of valid macro names supported by the compiler specified in build_compiler.
defines_object_static: Must only contain any number of valid macro names supported by the compiler specified in build_compiler.
defines_program: Must only contain any number of valid macro names supported by the compiler specified in build_compiler.
defines_program_shared: Must only contain any number of valid macro names supported by the compiler specified in build_compiler.
defines_program_static: Must only contain any number of valid macro names supported by the compiler specified in build_compiler.
defines_shared: Must only contain any number of valid macro names supported by the compiler specified in build_compiler.
defines_static: Must only contain any number of valid macro names supported by the compiler specified in build_compiler.
environment: Environment variable names, case-sensitive, usually uppercase. May only contain characters allowed in an environment variable.
flags: Must only contain any number of parameters supported by the compiler specified in build_compiler.
flags_library: Must only contain any number of parameters supported by the compiler specified in build_compiler.
flags_library_shared: Must only contain any number of parameters supported by the compiler specified in build_compiler.
flags_library_static: Must only contain any number of parameters supported by the compiler specified in build_compiler.
flags_object: Must only contain any number of parameters supported by the compiler specified in build_compiler.
flags_object_shared: Must only contain any number of parameters supported by the compiler specified in build_compiler.
flags_object_static: Must only contain any number of parameters supported by the compiler specified in build_compiler.
flags_program: Must only contain any number of parameters supported by the compiler specified in build_compiler.
flags_program_shared: Must only contain any number of parameters supported by the compiler specified in build_compiler.
flags_program_static: Must only contain any number of parameters supported by the compiler specified in build_compiler.
flags_shared: Must only contain any number of parameters supported by the compiler specified in build_compiler.
flags_static: Must only contain any number of parameters supported by the compiler specified in build_compiler.
has_path_standard: Must only one of: yes or no.
modes: Any valid word character, -, or +.
modes_default: May only be a single complete Content word defined in modes Object.
path_headers: Must be a single valid path.
path_language: Must be a single valid path.
path_library_script: Must be a single valid path.
path_library_shared: Must be a single valid path.
path_library_static: Must be a single valid path.
path_object_script: Must be a single valid path.
path_object_shared: Must be a single valid path.
path_object_static: Must be a single valid path.
path_program_script: Must be a single valid path.
path_program_shared: Must be a single valid path.
path_program_static: Must be a single valid path.
path_sources: Must only be a valid directory path or not specified.
path_sources_object: Must only be a valid directory path or not specified.
preserve_path_headers: Must only be one of yes or no.
process_post: Must contain only a single valid filename.
process_pre: Must contain only a single valid filename.
search_exclusive: Must only one of: yes or no.
search_shared: Must only one of: yes or no.
search_static: Must only one of: yes or no.
version_file: Must only be one of: major, minor, micro, or nano.
version_major: Must only be a single value containing valid filename characters.
version_major_prefix: Must be zero or more valid filename characters.
version_micro: Must only be a single value containing valid filename characters.
version_micro_prefix: Must be zero or more valid filename characters.
version_minor: Must only be a single value containing valid filename characters.
version_minor_prefix: Must be zero or more valid filename characters.
version_nano: Must only be a single value containing valid filename characters.
version_nano_prefix: Must be zero or more valid filename characters.
version_target: Must only be one of: major, minor, micro, or nano.

+ All Object names support having a - and a mode name, such as build_libraries-individual for a mode called individual, except for the modes and the modes_default Object names. +

+ +

Settings Documentation

+ +

+ This describes intent and purposes of the build settings file settings. +

+ The settings file is designed for very simple compilations that represent a single named program and/or a single named library. +

+ For specific details on the allowed formatting, see the settings.txt under the specifications folder. +

+
build_compiler:
+
+ This represents the name of the compiler program to use, such as gcc. +
+
+ This defaults to gcc (the GNU C Compiler). +
+
+ The programs gcc and clang are known to work. +
+
+ Many of the parameters in the settings file can be changed if using a non-GCC, but there may be certain hard-coded functionality that may need to be changed. +
+
+
build_indexer:
+
+ This represents the name of the indexer program to use, such as ar. +
+
+ An indexer is often called a linker. +
+
+ This defaults to ar (the GNU ar program). +
+
+ Similar to build_compiler, any linker that supports the ar program parameters is effectively supported. +
+
+
build_indexer_arguments:
+
+ This represents arguments needed to build an archive file from object files, such as rcs. +
+
+ These arguments are placed immediately before the object files passed to the indexer program. +
+
+
build_language:
+
+ The programming language to build with. +
+
+ The languages c and c++ are supported (with bash as a consideration for support). +
+
+ The bash language is not currently implemented and needs some consideration because there is nothing to compile. +
+
+ The bash language will likely build a set of individual scripts, and perhaps script dependencies, into a single Bash script. +
+
+
build_libraries:
+
+ A collection of libraries to be linked against. +
+
+ This should include the compiler specific parameter parts, such as the -l prefix in -lc. +
+
+ The order of these may matter if the compiler (such as GCC or a linker via GCC) is order sensitive. +
+
+
build_libraries_shared:
+
+ A collection of libraries to be linked against. +
+
+ This should include the compiler specific parameter parts, such as the -l prefix in -lc. +
+
+ The order of these may matter if the compiler (such as GCC or a linker via GCC) is order sensitive. +
+
+ These are applied to only shared builds. +
+
+
build_libraries_static:
+
+ A collection of libraries to be linked against. +
+
+ This should include the compiler specific parameter parts, such as the -l prefix in -lc. +
+
+ The order of these may matter if the compiler (such as GCC or a linker via GCC) is order sensitive. +
+
+ These are applied to only static builds. +
+
+
build_objects_library:
+
+ A collection of object files to be compile with when building libraries. +
+
+ These are intended to represent already compiled object files. +
+
+ These paths are relative to the path_object_script, path_object_shared, or path_object_static. +
+
+ The order of these may matter if the compiler (such as GCC or a linker via GCC) is order sensitive. +
+
+
build_objects_library_shared:
+
+ A collection of object files to be compile with when building shared libraries. +
+
+ These are intended to represent already compiled object files. +
+
+ These paths are relative to the path_object_shared. +
+
+ The order of these may matter if the compiler (such as GCC or a linker via GCC) is order sensitive. +
+
+ These are applied to only shared builds. +
+
+
build_objects_library_static:
+
+ A collection of object files to be compile with when building static libraries. +
+
+ These are intended to represent already compiled object files. +
+
+ These paths are relative to the path_object_static. +
+
+ The order of these may matter if the compiler (such as GCC or a linker via GCC) is order sensitive. +
+
+ These are applied to only static builds. +
+
+
build_objects_program:
+
+ A collection of object files to be compile with when building programs. +
+
+ These are intended to represent already compiled object files. +
+
+ These paths are relative to the path_object_script, path_object_shared, or path_object_static. +
+
+ The order of these may matter if the compiler (such as GCC or a linker via GCC) is order sensitive. +
+
+
build_objects_program_shared:
+
+ A collection of object files to be compile with when building shared programs. +
+
+ These are intended to represent already compiled object files. +
+
+ These paths are relative to the path_object_shared. +
+
+ The order of these may matter if the compiler (such as GCC or a linker via GCC) is order sensitive. +
+
+ These are applied to only shared builds. +
+
+
build_objects_program_static:
+
+ A collection of object files to be compile with when building static programs. +
+
+ These are intended to represent already compiled object files. +
+
+ These paths are relative to the path_object_static. +
+
+ The order of these may matter if the compiler (such as GCC or a linker via GCC) is order sensitive. +
+
+ These are applied to only static builds. +
+
+
build_name:
+
+ The name of the build, which often represent the project name. +
+
+ If program sources are specified, then this will be used as the program name. +
+
+ If library sources are specified, then this will be used in the library name, such as libX.so where X would be the build_name value. +
+
+
build_script:
+
+ When yes, the build process will build any scripts, such as a Bash script. +
+
+ This is currently not implemented. +
+
+
build_shared:
+
+ When yes, the build process will compile any source code for any supported language that supports shared library linking. +
+
+
build_sources_headers:
+
+ A collection of header files. +
+
+ May include a relative sub-path to each individual header (such as: level_0/a.h level_0/b.h level_1/c.h). +
+
+ The order of these may matter if the compiler (such as GCC or a linker via GCC) is order sensitive. +
+
+
build_sources_headers_shared:
+
+ A collection of header files. +
+
+ May include a relative sub-path to each individual header (such as: level_0/a.h level_0/b.h level_1/c.h). +
+
+ The order of these may matter if the compiler (such as GCC or a linker via GCC) is order sensitive. +
+
+ Be careful not to have any conflicting names between this and build_sources_headers_static in case of when static and shared builds are both enabled. +
+
+ These are applied to only shared builds. +
+
+
build_sources_headers_static:
+
+ A collection of header files. +
+
+ May include a relative sub-path to each individual header (such as: level_0/a.h level_0/b.h level_1/c.h). +
+
+ The order of these may matter if the compiler (such as GCC or a linker via GCC) is order sensitive. +
+
+ These files are used when compiling the library. +
+
+ Be careful not to have any conflicting names between this and build_sources_headers_shared in case of when static and shared builds are both enabled. +
+
+ These are applied to only static builds. +
+
+
build_sources_library:
+
+ A collection of library related source files. +
+
+ May include a relative sub-path to each individual source file (such as: level_0/a.c level_0/b.c level_1/c.c). +
+
+ The order of these may matter if the compiler (such as GCC or a linker via GCC) is order sensitive. +
+
+
build_sources_library_shared:
+
+ A collection of library related source files. +
+
+ May include a relative sub-path to each individual source file (such as: level_0/a.c level_0/b.c level_1/c.c). +
+
+ The order of these may matter if the compiler (such as GCC or a linker via GCC) is order sensitive. +
+
+ These are applied to only shared builds. +
+
+
build_sources_library_static:
+
+ A collection of library related source files. +
+
+ May include a relative sub-path to each individual source file (such as: level_0/a.c level_0/b.c level_1/c.c). +
+
+ The order of these may matter if the compiler (such as GCC or a linker via GCC) is order sensitive. +
+
+ These are applied to only static builds. +
+
+
build_sources_object:
+
+ A single source file used for generating an object file. +
+
+ The source file is located within the path designated by path_sources_object. +
+
+ The built object does not get linked and therefore no linker arguments apply. +
+
+ The built object file is named using the build_name with the .o extension. +
+
+ May include a relative sub-path to each individual source file (such as: level_0/a.c). +
+
+
build_sources_object_shared:
+
+ A single source file used for generating an object file. +
+
+ The source file is located within the path designated by path_sources_object. +
+
+ The built object does not get linked and therefore no linker arguments apply. +
+
+ The built object file is named using the build_name with the .o extension. +
+
+ May include a relative sub-path to each individual source file (such as: level_0/a.c). +
+
+ These are applied to only shared builds. +
+
+
build_sources_object_static:
+
+ A single source file used for generating an object file. +
+
+ The source file is located within the path designated by path_sources_object. +
+
+ The built object does not get linked and therefore no linker arguments apply. +
+
+ The built object file is named using the build_name with the .o extension. +
+
+ May include a relative sub-path to each individual source file (such as: level_0/a.c). +
+
+ These are applied to only static builds. +
+
+
build_sources_program:
+
+ A collection of program related source files. +
+
+ May include a relative sub-path to each individual source file (such as: level_0/a.c level_0/b.c level_1/c.c). +
+
+ The order of these may matter if the compiler (such as GCC or a linker via GCC) is order sensitive. +
+
+ These files are used when compiling the program. +
+
+
build_sources_program_shared:
+
+ A collection of program related source files. +
+
+ May include a relative sub-path to each individual source file (such as: level_0/a.c level_0/b.c level_1/c.c). +
+
+ The order of these may matter if the compiler (such as GCC or a linker via GCC) is order sensitive. +
+
+ These files are used when compiling the program for shared builds. +
+
+
build_sources_program_static:
+
+ A collection of program related source files. +
+
+ May include a relative sub-path to each individual source file (such as: level_0/a.c level_0/b.c level_1/c.c). +
+
+ The order of these may matter if the compiler (such as GCC or a linker via GCC) is order sensitive. +
+
+ These files are used when compiling the program for static builds. +
+
+
build_sources_script:
+
+ A collection of script files. +
+
+ These are settings files used by the project and are simply copied over to the build directory. +
+
+ Unless a pre-process script (or in theory post-process script) is configured to alter these, they are not modified. +
+
+ Unlike the compile_language setting bash, this is not for built Bash script, but is instead for any valid scripting language (including Bash). +
+
+ These could be in any language. +
+
+
build_sources_setting:
+
+ A collection of settings files. +
+
+ These are settings files used by the project and are simply copied over to the build directory. +
+
+ Unless a pre-process script (or in theory post-process script) is configured to alter these, they are not modified. +
+
+
build_static:
+
+ When yes, the build process will compile any source code for any supported language that supports static library linking. +
+
+
defines:
+
+ A collection of macro names. +
+
+ This includes the any compiler specific parameters required by the build_compiler, such as the -D used by gcc and clang. +
+
+ These will be appended to the compiler for compiled languages such as C and C++. +
+
+ These are applied to both shared and static builds. +
+
+
defines_library:
+
+ A collection of macro names. +
+
+ This includes the any compiler specific parameters required by the build_compiler, such as the -D used by gcc and clang. +
+
+ These will be appended to the compiler for compiled languages such as C and C++. +
+
+ These are applied to only library builds. +
+
+
defines_library_shared:
+
+ A collection of macro names. +
+
+ This includes the any compiler specific parameters required by the build_compiler, such as the -D used by gcc and clang. +
+
+ These will be appended to the compiler for compiled languages such as C and C++. +
+
+ These are applied to only shared library builds. +
+
+
defines_library_static:
+
+ A collection of macro names. +
+
+ This includes the any compiler specific parameters required by the build_compiler, such as the -D used by gcc and clang. +
+
+ These will be appended to the compiler for compiled languages such as C and C++. +
+
+ These are applied to only static library builds. +
+
+
defines_object:
+
+ A collection of macro names. +
+
+ This includes the any compiler specific parameters required by the build_compiler, such as the -D used by gcc and clang. +
+
+ These will be appended to the compiler for compiled languages such as C and C++. +
+
+ These are applied to only object builds. +
+
+
defines_object_shared:
+
+ A collection of macro names. +
+
+ This includes the any compiler specific parameters required by the build_compiler, such as the -D used by gcc and clang. +
+
+ These will be appended to the compiler for compiled languages such as C and C++. +
+
+ These are applied to only shared object builds. +
+
+
defines_object_static:
+
+ A collection of macro names. +
+
+ This includes the any compiler specific parameters required by the build_compiler, such as the -D used by gcc and clang. +
+
+ These will be appended to the compiler for compiled languages such as C and C++. +
+
+ These are applied to only static object builds. +
+
+
defines_program:
+
+ A collection of macro names. +
+
+ This includes the any compiler specific parameters required by the build_compiler, such as the -D used by gcc and clang. +
+
+ These will be appended to the compiler for compiled languages such as C and C++. +
+
+ These are applied to only program builds. +
+
+
defines_program_shared:
+
+ A collection of macro names. +
+
+ This includes the any compiler specific parameters required by the build_compiler, such as the -D used by gcc and clang. +
+
+ These will be appended to the compiler for compiled languages such as C and C++. +
+
+ These are applied to only shared program builds. +
+
+
defines_program_static:
+
+ A collection of macro names. +
+
+ This includes the any compiler specific parameters required by the build_compiler, such as the -D used by gcc and clang. +
+
+ These will be appended to the compiler for compiled languages such as C and C++. +
+
+ These are applied to only shared program builds. +
+
+
defines_shared:
+
+ A collection of macro names. +
+
+ This includes the any compiler specific parameters required by the build_compiler, such as the -D used by gcc and clang. +
+
+ These will be appended to the compiler for compiled languages such as C and C++. +
+
+ These are applied to only shared builds. +
+
+
defines_static:
+
+ A collection of macro names. +
+
+ This includes the any compiler specific parameters required by the build_compiler, such as the -D used by gcc and clang. +
+
+ These will be appended to the compiler for compiled languages such as C and C++. +
+
+ These are applied to only static builds. +
+
+
environment:
+
+ A collection of environment names to pass from the callers environment into the executed programs environment. +
+
+ When provided, all environment variables are removed when calling user-space programs, such as gcc. +
+
+ To remove all environment variables define this with no Content. +
+
+ When not provided, all environment variables are loaded. +
+
+
flags:
+
+ A collection of any flag supported by the build_compiler, such as gcc. +
+
+ This includes the any compiler specific parameters to defined this, such as the -f used by gcc and clang. +
+
+ These are applied to both shared and static builds. +
+
+
flags_library:
+
+ A collection of any flag supported by the build_compiler, such as gcc. +
+
+ This includes the any compiler specific parameters to defined this, such as the -f used by gcc and clang. +
+
+ These are applied when building a library. +
+
+
flags_library_shared:
+
+ A collection of any flag supported by the build_compiler, such as gcc. +
+
+ This includes the any compiler specific parameters to defined this, such as the -f used by gcc and clang. +
+
+ These are applied to only library shared builds. +
+
+
flags_library_static:
+
+ A collection of any flag supported by the build_compiler, such as gcc. +
+
+ This includes the any compiler specific parameters to defined this, such as the -f used by gcc and clang. +
+
+ These are applied to only library static builds. +
+
+
flags_object:
+
+ A collection of any flag supported by the build_compiler, such as gcc. +
+
+ This includes the any compiler specific parameters to defined this, such as the -f used by gcc and clang. +
+
+ These are applied when building an object. +
+
+
flags_object_shared:
+
+ A collection of any flag supported by the build_compiler, such as gcc. +
+
+ This includes the any compiler specific parameters to defined this, such as the -f used by gcc and clang. +
+
+ These are applied to only object shared builds. +
+
+
flags_object_static:
+
+ A collection of any flag supported by the build_compiler, such as gcc. +
+
+ This includes the any compiler specific parameters to defined this, such as the -f used by gcc and clang. +
+
+ These are applied to only object static builds. +
+
+
flags_program:
+
+ A collection of any flag supported by the build_compiler, such as gcc. +
+
+ This includes the any compiler specific parameters to defined this, such as the -f used by gcc and clang. +
+
+ These are applied when building a program. +
+
+
flags_program_shared:
+
+ A collection of any flag supported by the build_compiler, such as gcc. +
+
+ This includes the any compiler specific parameters to defined this, such as the -f used by gcc and clang. +
+
+ These are applied to only program shared builds. +
+
+
flags_program_static:
+
+ A collection of any flag supported by the build_compiler, such as gcc. +
+
+ This includes the any compiler specific parameters to defined this, such as the -f used by gcc and clang. +
+
+ These are applied to only program static builds. +
+
+
flags_shared:
+
+ A collection of any flag supported by the build_compiler, such as gcc. +
+
+ This includes the any compiler specific parameters to defined this, such as the -f used by gcc and clang. +
+
+ These are applied to only shared builds. +
+
+
flags_static:
+
+ A collection of any flag supported by the build_compiler, such as gcc. +
+
+ This includes the any compiler specific parameters to defined this, such as the -f used by gcc and clang. +
+
+ These are applied to only static builds. +
+
+
has_path_standard:
+
+ When yes, the sources path will be built using the sources path with the language, such as sources/c/. +
+
+ When no, the default sources path structure is not used and instead path_sources is used. +
+
+ When the parameter -S/--sources is specified, such as -S xxx, then when this is set to yes is used then the path would be xxx/c/ and when this is set to no then the path would be xxx/. +
+
+ This defaults to yes. +
+
+
modes:
+
+
+ A collection of available build modes. +
+
+ Build modes provide custom variants of the build process where certain settings are appended onto others. +
+
+ See the settings.txt specification for a list of which setting names this applies to. +
+
+
modes_default:
+
+ The name of the default mode to use when no mode is specified. +
+
+ This must be one of the modes specified in the modes setting. +
+
+
path_headers:
+
+
+ A sub-path in which headers are to be installed under. +
+
+ For example, the FLL project might use the level_0, level_1, etc.. headers without requiring that structure within the source. +
+
+ A resulting build destination for a path_headers of level_0 would be something like build/includes/level_0/. +
+
+ If path_headers is level_0, preserve_path_headers is yes, and build_sources_headers has xxx/a.h yyy/zzz/b.h, then the headers would be at: build/includes/level_0/xxx/a.h build/includes/level_0/yyy/zzz/b.h +
+
+
path_language:
+
+ A sub-path in which to find the source files for the currently defined language. +
+
+ If the build_language is changed, it is recommended to change this as well to match. +
+
+
path_library_script:
+
+ A sub-path representing the destination where the built library script files are placed. +
+
+ This defaults to script. +
+
+ This is currently not implemented. +
+
+
path_library_shared:
+
+ A sub-path representing the destination where the built shared library files are placed. +
+
+ This defaults to shared. +
+
+
path_library_static:
+
+ A sub-path representing the destination where the built shared library files are placed. +
+
+ This defaults to static. +
+
+
path_object_script:
+
+ A sub-path representing the destination where the built object script files are placed. +
+
+ This defaults to script. +
+
+ This is currently not implemented. +
+
+
path_object_shared:
+
+ A sub-path representing the destination where the built object library files are placed. +
+
+ This defaults to shared. +
+
+
path_object_static:
+
+ A sub-path representing the destination where the built object library files are placed. +
+
+ This defaults to static. +
+
+
path_program_script:
+
+ A sub-path representing the destination where the built program script files are placed. +
+
+ This defaults to script. +
+
+ This is currently not implemented. +
+
+
path_program_shared:
+
+ A sub-path representing the destination where the built shared program files are placed. +
+
+ This defaults to shared. +
+
+
path_program_static:
+
+
+ A sub-path representing the destination where built shared program files are placed. +
+
+ This defaults to static. +
+
+
path_sources:
+
+ A sub-path representing where the source files are found. +
+
+ This defaults to sources. +
+
+
path_sources_object:
+
+ A sub-path representing where the object source files are found. +
+
+ This is used by build_sources_object. +
+
+ This defaults to sources. +
+
+
preserve_path_headers:
+
+ When this is yes, then the relative directory structure in the source (as defined in build_sources_headers) is preserved. +
+
+ If the build_sources_headers has the header files xxx/a.h yyy/zzz/b.h and this is yes, then the directories xxx/ and yyy/zzz/ are created and the files are stored within them. +
+
+ If the build_sources_headers has the header files xxx/a.h yyy/zzz/b.h and this is no, then the directories xxx/ and yyy/zzz/ are stripped before installing. +
+
+ When this is no and the build_sources_headers has header files xxx/a.h yyy/a.h, then one of the a.h files will be overwritten, depending on order they were supplied. +
+
+
process_post:
+
+ The filename (relative to the data/build/ directory) of a script to execute after the build operation successfully completes. +
+
+ A small subset of parameters from the main execution are passed to this script during execution as parameters (using short parameter codes): +
+
- Color context parameters, such as: +l, +n, and +d.
- Operation mode, such as: build, clean, make, or skeleton.
- Verbosity parameters, such as: +q, +D, or +V.
- Define parameters, such as -d X or -d Y, whereas X or Y are any valid argument associated with -d.
- Process parameter, such as -p X, whereas X is any valid argument associated with -p.
- Settings parameter, such as -s X', whereas code:X" is any valid argument associated with -s.
- Build Path parameter, such as -b X', whereas code:X" is any valid argument associated with -b.
- Data Path parameter, such as -D X', whereas code:X" is any valid argument associated with -D.
- Sources Path parameter, such as -S X', whereas code:X" is any valid argument associated with -S.
- Work Path parameter, such as -w X', whereas code:X" is any valid argument associated with -w.
+
+
process_pre:
+
+ The filename (relative to the data/build/ directory) of a script to execute before the build operation is executed. +
+
+ A small subset of parameters from the main execution are passed to this script during execution as parameters (using short parameter codes): +
+
- Color context parameters, such as: +l, +n, and +d.
- Operation mode, such as: build, clean, make, or skeleton.
- Verbosity parameters, such as: +q, +D, or +V.
- Define parameters, such as -d X or -d Y, whereas X or Y are any valid argument associated with -d.
- Process parameter, such as -p X, whereas X is any valid argument associated with -p.
- Settings parameter, such as -s X', whereas code:X" is any valid argument associated with -s.
- Build Path parameter, such as -b X', whereas code:X" is any valid argument associated with -b.
- Data Path parameter, such as -D X', whereas code:X" is any valid argument associated with -D.
- Sources Path parameter, such as -S X', whereas code:X" is any valid argument associated with -S.
- Work Path parameter, such as -w X', whereas code:X" is any valid argument associated with -w.
+
+
search_exclusive:
+
+ When yes, the search path during compile for shared libraries will only include shared library paths. +
+
+ When no, the search path during compile time for shared libraries will include shared library paths followed by static library paths. +
+
+ Setting this to yes helps prevent static libraries from ending up in shared libraries (very useful when bootstrapping a system). +
+
+ Setting this to no allows for including static libraries if no shared libraries are found but static are. +
+
+ This does not alter search paths introduced automatically by the build_compiler or build_indexer, so it is still possible for static libraries to end up even when this is set to yes. +
+
+
search_shared:
+
+ When yes, shared library paths are searched during compile. +
+
+ Both this and search_static cannot be no at the same time. +
+
+ This defaults to yes. +
+
+
search_shared:
+
+ When yes, static library paths are searched during compile. +
+
+ Both this and search_shared cannot be no at the same time. +
+
+
version_file:
+
+ Designates which version should be used when building the symbolic links. +
+
+ Any version prefixes are used as defined. +
+
+ A Symbolic link is created against this created file such that libX.so is a link to libX.so.A. +
+
+ For all files other than when file is major, another symbolic link is created against this such that libX.so.A is a link to libX.so.A.X such that X is the respective B, B.C', or code:B.C.D" as described below. +
+
+ The default file is major. +
+
+ When major is used, the file created is libX.so.A, whereas X is the build_name and A is the major version. +
+
+ When minor is used, the file created is libX.so.A.B, whereas X is the build_name and A.B is the major and minor versions, respectively. +
+
+ When micro is used, the file created is libX.so.A.B.C, whereas X is the build_name and A.B.C is the major, minor, and micro versions, respectively. +
+
+ When nano is used, the file created is libX.so.A.B.C.D, whereas X is the build_name and A.B.C.D is the major, minor, micro, and nano versions, respectively. +
+
+
version_major:
+
+ The major version number (or in theory any characters allowed in a filename). +
+
+ This should generally be a positive number or 0. +
+
+ Anything else is currently untested but allowed. +
+
+ With a structure of A.B.C, the major version would be the A. +
+
+
version_major_prefix:
+
+ The version major prefix is the character used to designate the start of the major version. +
+
+ This can zero or more characters. +
+
+ With a structure of A.B.C, the major version prefix would be before the A. +
+
+ This is only added if version_major is not empty. +
+
+ This defaults to the ASCII period character .. +
+
+
version_minor:
+
+ The minor version number (or in theory any characters allowed in a filename). +
+
+ This should generally be a positive number or 0. +
+
+ Anything else is currently untested but allowed. +
+
+ With a structure of A.B.C, the minor version would be the B. +
+
+
version_minor_prefix:
+
+ The version minor prefix is the character used to separate the major from the minor. +
+
+ This can zero or more characters. +
+
+ With a structure of A.B.C, the minor version prefix would be the . before the B. +
+
+ This is only added if version_minor is not empty. +
+
+ This defaults to the ASCII period character .. +
+
+
version_micro:
+
+ The micro version number (or in theory any characters allowed in a filename). +
+
+ This should generally be a positive number or 0. +
+
+ Anything else is currently untested but allowed. +
+
+ With a structure of A.B.C, the micro version would be the C. +
+
+
version_micro_prefix:
+
+ The version micro prefix is the character used to separate the minor from the micro. +
+
+ This can zero or more characters. +
+
+ With a structure of A.B.C, the micro version prefix would be the . before the C. +
+
+ This is only added if version_micro is not empty. +
+
+ This defaults to the ASCII period character .. +
+
+
version_nano:
+
+ The nano version number (or in theory any characters allowed in a filename). +
+
+ This should generally be a positive number or 0. +
+
+ Anything else is currently untested but allowed. +
+
+ With a structure of A.B.C.D, the micro version prefix would be the . before the D. +
+
+
version_nano_prefix:
+
+ The version nano prefix is the character used to separate the micro from the nano. +
+
+ This can zero or more characters. +
+
+ With a structure of A.B.C.D, the minor version would be the . before the D. +
+
+ This is only added if version_nano is not empty. +
+
+ This defaults to the ASCII period character .. +
+
+
version_target:
+
+ Designates which version should be used when linking the shared library. +
+
+ Any version prefixes are used as defined. +
+
+ The default target is micro. +
+
+ When major is used, a shared library is generated with -Wl,-soname,libX.so.A, whereas X is the build_name and A is the major version. +
+
+ When minor is used, a shared library is generated with -Wl,-soname,libX.so.A.B, whereas X is the build_name and A.B is the major and minor versions, respectively. +
+
+ When micro is used, a shared library is generated with -Wl,-soname,libX.so.A.B.C, whereas X is the build_name and A.B.C is the major, minor, and micro versions, respectively. +
+
+ When nano is used, a shared library is generated with -Wl,-soname,libX.so.A.B.C.D, whereas X is the build_name and A.B.C.D is the major, minor, micro, and nano versions, respectively. +
+

Featureless Make Defines Specification

Featureless Make Dependencies Specification

Featureless Make Fakefile Specification

Fakefile Documentation

Featureless Make Settings Specification

Settings Documentation