]> Kevux Git Server - fll/commitdiff
Cleanup: Fix styling, spelling, and wording mistakes in the specifications and docume...
authorKevin Day <thekevinday@gmail.com>
Mon, 12 Dec 2022 00:36:59 +0000 (18:36 -0600)
committerKevin Day <thekevinday@gmail.com>
Mon, 12 Dec 2022 00:36:59 +0000 (18:36 -0600)
level_3/fake/documents/fakefile.txt
level_3/fake/documents/settings.txt
level_3/fake/specifications/settings.txt

index a44099b7d72676499b78f453d0a45b6923a0e7bc..6f8a34301572804499c85f95090c185c8160d90d 100644 (file)
@@ -52,7 +52,7 @@ Fakefile Documentation:
         - code:"warn": Designates to continue on and if in verbose mode then print a warning.
         - code:"ignore": Designates to do nothing.
 
-      The return code for programs can still be retrieved through using the reserved IKI vaiable code:"return".
+      The return code for programs can still be retrieved through using the reserved IKI variable code:"return".
 
     - code:"indexer"\:
       This represents the name of the indexer program to use, such as code:"ar".
index a1c3887564227430372e831d67b01421959e5f40..c3e94eccdc9050e216c09eb956ccffef27ca9c80 100644 (file)
@@ -10,7 +10,7 @@
 #
 
 Settings Documentation:
-  This describes intent and purposes of the build bold:"settings" file settings.
+  This describes intent and purposes of the build bold:"settings" file bold:"settings".
   The bold:"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 file:"settings.txt" under the specifications folder.
 
@@ -188,7 +188,7 @@ Settings Documentation:
 
   - code:"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.
+    These are script 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 code:"compile_language" setting code:"bash", this is not for built Bash script, but is instead for any valid scripting language (including Bash).
     These could be in any language.
@@ -348,7 +348,7 @@ Settings Documentation:
 
   - code:"modes"\:
     A collection of available build modes.
-    Build modes provide custom variants of the build process where certain settings are appended onto others.
+    Build modes provide custom variants of the build process where certain bold:"settings" are appended onto others.
     See the file:"settings.txt" specification for a list of which setting names this applies to.
 
   - code:"modes_default"\:
index 28ff9f71b89e29fbc467c8e5d11a68b9416c13b2..a74d075fab0b67dbd9127464e0db28e90ba47f74 100644 (file)
@@ -19,8 +19,8 @@ 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\:
-    - code:"build_compiler": Must only be a valid filename.
-    - code:"build_indexer": Must only be a valid filename.
+    - code:"build_compiler": Only one Content, which must only be a valid filename.
+    - code:"build_indexer": Only one Content, which must only be a valid filename.
     - code:"build_indexer_arguments": Zero or more arguments supported by the indexer specified in code:"build_indexer".
     - code:"build_language": Must only be one of: code:"bash", code:"c", or code:"c++".
     - code:"build_libraries": Must only contain any number of valid library include arguments that are valid for the compiler defined in "build_compiler" Object.
@@ -92,8 +92,8 @@ Settings Specification:
     - code:"path_sources": Must only be a valid directory path or not specified.
     - code:"path_sources_object": Must only be a valid directory path or not specified.
     - code:"preserve_path_headers": Must only be one of code:"yes" or code:"no".
-    - code:"process_post": Must contain only a single valid filename.
-    - code:"process_pre": Must contain only a single valid filename.
+    - code:"process_post": Only one Content, which must only be a valid filename.
+    - code:"process_pre": Only one Content, which must only be a valid filename.
     - code:"search_exclusive": Must only one of: code:"yes" or code:"no".
     - code:"search_shared": Must only one of: code:"yes" or code:"no".
     - code:"search_static": Must only one of: code:"yes" or code:"no".