Deployed 898d5a6 to latest with MkDocs 1.6.1 and mike 2.1.3

Author: Neko-Box-Coder

latest/TODO/index.html

@@ -644,18 +644,27 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#v030" class="md-nav__link">
+  <a href="#nightly" class="md-nav__link">
     <span class="md-ellipsis">
-      v0.3.0
+      Nightly
     </span>
   </a>
 
 </li>
 
           <li class="md-nav__item">
-  <a href="#nightly" class="md-nav__link">
+  <a href="#v031" class="md-nav__link">
     <span class="md-ellipsis">
-      Nightly
+      v0.3.1
+    </span>
+  </a>
+  
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#v030" class="md-nav__link">
+    <span class="md-ellipsis">
+      v0.3.0
     </span>
   </a>
 
@@ -736,6 +745,14 @@
 
 <h1 id="roadmap">Roadmap</h1>
 <h2 id="done">Done</h2>
+<h3 id="nightly">Nightly</h3>
+<ul>
+<li>Add version for default user config and prompt for update</li>
+</ul>
+<h3 id="v031">v0.3.1</h3>
+<ul>
+<li>Check last run is shared lib or executable. Reset cache when necessary if different type</li>
+</ul>
 <h3 id="v030">v0.3.0</h3>
 <ul>
 <li>More git options<ul>
@@ -761,25 +778,27 @@ <h3 id="v030">v0.3.0</h3>
 <li>Add ability to reference local YAML file for config profiles</li>
 <li>Add interactive tutorials and redo documentations</li>
 </ul>
-<h3 id="nightly">Nightly</h3>
 <h2 id="planned">Planned</h2>
 <h3 id="v040">v0.4.0</h3>
 <ul>
 <li>Allow runcpp2 to be library for scriptable pipeline</li>
-<li>Add version for default user config and prompt for update</li>
 <li>Add more default profiles</li>
 <li>Migrate to libyaml</li>
-<li>Ability to compile runcpp2 as single cpp</li>
+<li>Ability to compile runcpp2 as single cpp, to ditch cmake</li>
 </ul>
 <h2 id="high-priority">High Priority</h2>
 <ul>
+<li>Rename "OtherFilesToBeCompiled" to "SourceFiles"</li>
+<li>Expose/rename "InternalExecutableShared" and change BuildType to be platform map<ul>
+<li>This ties to the warning in <code>CompilingLinking.cpp:619</code></li>
+</ul>
+</li>
 <li>Update <code>FileProperties.hpp</code> to use list of string for prefix and extension<ul>
 <li>Merge <code>SharedLinkFile</code> and <code>SharedLibraryFile</code></li>
 </ul>
 </li>
 <li>Add the ability for user to specify custom substitution options which applies to all fields</li>
 <li>Add the ability to append defines coming from the dependencies</li>
-<li>Check last run is shared lib or executable. Reset cache when necessary if different type (<code>Src/runcpp2/CompilingLinking.cpp:502 LinkScript()</code>)</li>
 <li>Add wildcard support for filenames and extensions (Files Globbing)</li>
 <li>Add the ability to query script build directory</li>
 <li>Add the ability to list script dependencies</li>

latest/build_settings/index.html

@@ -1137,6 +1137,19 @@ <h3 id="buildtype"><code>BuildType</code></h3>
 <div class="language-yaml highlight"><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="nt">BuildType</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Executable</span>
 </span></code></pre></div>
 </details>
+<div class="admonition warning">
+<p class="admonition-title">Warning</p>
+<p>When you specify <code>BuildType</code> as <code>Executable</code>, it will still produce a <strong>shared library</strong> for running.
+Under the hood, runcpp2 simply loads the shared library and call the <code>main()</code> function.</p>
+<p>The reason of this behavior is because this makes it possible to "catch" if there's any
+missing external (shared) libraries that failed to be resolved, either because of missing
+<code>.dll</code>/<code>.so</code> or misconfigured search path. </p>
+<p>This allows runcpp2 to differentiate a failure on resolving shared library and if the program
+just returns a non-zero exit code.</p>
+<p>Therefore, when calling with the build flag <code>--build</code>, the output of the binary is <strong>shared 
+library instead of an executable</strong>. This behavior can be <strong>overridden</strong> by passing the 
+<code>--executable</code>/<code>-e</code> flag to force runcpp2 to produce the executable.</p>
+</div>
 <h3 id="requiredprofiles"><code>RequiredProfiles</code></h3>
 <ul>
 <li>Type: <code>Platform Profile List</code></li>
@@ -1154,23 +1167,23 @@ <h3 id="requiredprofiles"><code>RequiredProfiles</code></h3>
 </details>
 <h3 id="overridecompileflags"><code>OverrideCompileFlags</code></h3>
 <ul>
-<li>Type: <code>Platform Profile Map</code></li>
+<li>Type: <code>Platform Profile Map</code> with child fields</li>
 <li>Optional: <code>true</code></li>
 <li>Default: None</li>
-<li>Description: The compile flags to override for each platform and profile.</li>
+<li>Description: The compile flags to override for the profile being run under each platform.</li>
 <li>Child Fields:<ul>
 <li><code>Remove</code><ul>
 <li>Type: <code>string</code></li>
 <li>Optional: <code>true</code></li>
 <li>Default: None</li>
-<li>Description: The compile flags to remove for each platform and profile.</li>
+<li>Description: The compile flags to remove for the profile being run.</li>
 </ul>
 </li>
 <li><code>Append</code><ul>
 <li>Type: <code>string</code></li>
 <li>Optional: <code>true</code></li>
 <li>Default: None</li>
-<li>Description: The compile flags to append for each platform and profile.</li>
+<li>Description: The compile flags to append for the profile being run.</li>
 </ul>
 </li>
 </ul>
@@ -1190,20 +1203,20 @@ <h3 id="overridelinkflags"><code>OverrideLinkFlags</code></h3>
 <li>Type: <code>Platform Profile Map</code> with child fields</li>
 <li>Optional: <code>true</code></li>
 <li>Default: None</li>
-<li>Description: The link flags to override for each platform and profile.</li>
+<li>Description: The link flags to override for the profile being run under each platform.</li>
 <li>Child Fields:<ul>
 <li><code>Remove</code><ul>
 <li>Type: <code>string</code></li>
 <li>Optional: <code>true</code></li>
 <li>Default: None</li>
-<li>Description: The link flags to remove for each platform and profile.</li>
+<li>Description: The link flags to remove for the profile being run.</li>
 </ul>
 </li>
 <li><code>Append</code><ul>
 <li>Type: <code>string</code></li>
 <li>Optional: <code>true</code></li>
 <li>Default: None</li>
-<li>Description: The link flags to append for each platform and profile.</li>
+<li>Description: The link flags to append for the profile being run.</li>
 </ul>
 </li>
 </ul>
@@ -1270,7 +1283,7 @@ <h3 id="setup"><code>Setup</code></h3>
 <li>Type: <code>Platform Profile Map</code> with <code>list</code> of <code>string</code></li>
 <li>Optional: <code>true</code></li>
 <li>Default: None</li>
-<li>Description: The setup commands to be used for each platform and profile.</li>
+<li>Description: The setup commands to be used for each platform and profile. This runs before the script built for the first time.</li>
 </ul>
 <details class="example">
 <summary>Example</summary>
@@ -1285,7 +1298,7 @@ <h3 id="prebuild"><code>PreBuild</code></h3>
 <li>Type: <code>Platform Profile Map</code> with <code>list</code> of <code>string</code></li>
 <li>Optional: <code>true</code></li>
 <li>Default: None</li>
-<li>Description: The pre-build commands to be used for each platform and profile.</li>
+<li>Description: The pre-build commands to be used for each platform and profile. This runs before each build.</li>
 </ul>
 <details class="example">
 <summary>Example</summary>
@@ -1300,7 +1313,7 @@ <h3 id="postbuild"><code>PostBuild</code></h3>
 <li>Type: <code>Platform Profile Map</code> with <code>list</code> of <code>string</code></li>
 <li>Optional: <code>true</code></li>
 <li>Default: None</li>
-<li>Description: The post-build commands to be used for each platform and profile.</li>
+<li>Description: The post-build commands to be used for each platform and profile. This runs after each build.</li>
 </ul>
 <details class="example">
 <summary>Example</summary>
@@ -1315,7 +1328,7 @@ <h3 id="cleanup"><code>Cleanup</code></h3>
 <li>Type: <code>Platform Profile Map</code> with <code>list</code> of <code>string</code></li>
 <li>Optional: <code>true</code></li>
 <li>Default: None</li>
-<li>Description: The cleanup commands to be used for each platform and profile.</li>
+<li>Description: The cleanup commands to be used for each platform and profile. This runs when <code>--cleanup</code> command is specified.</li>
 </ul>
 <details class="example">
 <summary>Example</summary>