From: Kevin Day Date: Mon, 24 Jan 2022 01:39:01 +0000 (-0600) Subject: Cleanup: The documentation. X-Git-Tag: 0.5.8~92 X-Git-Url: https://git.kevux.org/?a=commitdiff_plain;h=c98640d904d0fab113022ff5d8e94c588ff6774e;p=fll Cleanup: The documentation. --- diff --git a/level_3/fake/specifications/settings.txt b/level_3/fake/specifications/settings.txt index 1e514d6..6e4fbde 100644 --- a/level_3/fake/specifications/settings.txt +++ b/level_3/fake/specifications/settings.txt @@ -10,107 +10,107 @@ Settings Specification: 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_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_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_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_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". - - 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_headers_preserve: Must only be one of "yes" or "no". - - 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_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_standard: Must only one of: "yes" or "no". - - process_post: Must contain only a single valid filename. - - process_pre: Must contain only a single valid filename. - - project_name: Must only contain characters allowed in a 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_minor: Must only be a single value containing valid filename characters. - - version_minor_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_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". + - 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_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_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_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_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". + - 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_headers_preserve: Must only be one of "yes" or "no". + - 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_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_standard: Must only one of: "yes" or "no". + - process_post: Must contain only a single valid filename. + - process_pre: Must contain only a single valid filename. + - project_name: Must only contain characters allowed in a 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_minor: Must only be a single value containing valid filename characters. + - version_minor_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_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". The following Object names support having a "-" and a "mode" name, such as "build_libraries-individual" for a mode called "individual"\: - - build_libraries - - build_libraries_shared - - build_libraries_static - - build_sources_headers - - build_sources_headers_shared - - build_sources_headers_static - - build_sources_library - - build_sources_library_shared - - build_sources_library_static - - build_sources_program - - build_sources_program_shared - - build_sources_program_static - - build_sources_script - - build_sources_setting - - defines - - defines_library - - defines_library_shared - - defines_library_static - - defines_program - - defines_program_shared - - defines_program_static - - defines_shared - - defines_static - - environment - - flags - - flags_library - - flags_library_shared - - flags_library_static - - flags_program - - flags_program_shared - - flags_program_static - - flags_shared - - flags_static + - build_libraries + - build_libraries_shared + - build_libraries_static + - build_sources_headers + - build_sources_headers_shared + - build_sources_headers_static + - build_sources_library + - build_sources_library_shared + - build_sources_library_static + - build_sources_program + - build_sources_program_shared + - build_sources_program_static + - build_sources_script + - build_sources_setting + - defines + - defines_library + - defines_library_shared + - defines_library_static + - defines_program + - defines_program_shared + - defines_program_static + - defines_shared + - defines_static + - environment + - flags + - flags_library + - flags_library_shared + - flags_library_static + - flags_program + - flags_program_shared + - flags_program_static + - flags_shared + - flags_static