From 1899f9445d26fd8f40e2c971dc3c8309989f1266 Mon Sep 17 00:00:00 2001 From: Kevin Day Date: Sun, 11 Dec 2022 18:36:59 -0600 Subject: [PATCH] Cleanup: Fix styling, spelling, and wording mistakes in the specifications and documentation. --- level_3/fake/documents/fakefile.txt | 2 +- level_3/fake/documents/settings.txt | 6 +++--- level_3/fake/specifications/settings.txt | 8 ++++---- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/level_3/fake/documents/fakefile.txt b/level_3/fake/documents/fakefile.txt index a44099b..6f8a343 100644 --- a/level_3/fake/documents/fakefile.txt +++ b/level_3/fake/documents/fakefile.txt @@ -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". diff --git a/level_3/fake/documents/settings.txt b/level_3/fake/documents/settings.txt index a1c3887..c3e94ec 100644 --- a/level_3/fake/documents/settings.txt +++ b/level_3/fake/documents/settings.txt @@ -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"\: diff --git a/level_3/fake/specifications/settings.txt b/level_3/fake/specifications/settings.txt index 28ff9f7..a74d075 100644 --- a/level_3/fake/specifications/settings.txt +++ b/level_3/fake/specifications/settings.txt @@ -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". -- 1.8.3.1