Skip to content

Commit cbccafa

Browse files
Deployed 83c8329 to latest with MkDocs 1.6.1 and mike 2.1.3
1 parent 62ac04f commit cbccafa

File tree

10 files changed

+1565
-695
lines changed

10 files changed

+1565
-695
lines changed

latest/build_settings/index.html

Lines changed: 664 additions & 221 deletions
Large diffs are not rendered by default.

latest/guides/basic_concepts/index.html

Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -651,7 +651,8 @@
651651

652652
<h1 id="basic-concepts">Basic Concepts</h1>
653653
<h2 id="script-file">Script File</h2>
654-
<p>A script file is your entry point source file (typically a .cpp file) that runcpp2 uses to build with the settings specified either:</p>
654+
<p>A script file is your entry point source file (typically a .cpp file) that runcpp2 uses to build
655+
with the settings specified either:</p>
655656
<ul>
656657
<li>
657658
<p>As inline comments in the source file:
@@ -670,12 +671,15 @@ <h2 id="script-file">Script File</h2>
670671
</span></code></pre></div></p>
671672
</li>
672673
</ul>
673-
<p>The name of the final output will be the name of the script file, therefore a script file will always have a 1 to 1 relationship with the linker output, even if multiple sources are specified in the script file build settings. </p>
674+
<p>The name of the final output will be the name of the script file, therefore a script file will
675+
always have a 1 to 1 relationship with the linker output, even if multiple sources are specified in
676+
the script file build settings. </p>
674677
<p>You can use any of your source files as a script file, or a dedicated .cpp file for building.</p>
675678
<hr />
676679
<h2 id="platforms-and-profiles">Platforms And Profiles</h2>
677680
<p>runcpp2 uses platforms and profiles to organize build settings. </p>
678-
<p>Platforms represent different host operating systems (not the target platform), while profiles represent different compilers toolchains and their configurations.</p>
681+
<p>Platforms represent different host operating systems (not the target platform), while profiles
682+
represent different compilers toolchains and their configurations.</p>
679683
<h3 id="list-of-platforms">List Of Platforms</h3>
680684
<p>runcpp2 supports the following platforms:</p>
681685
<ul>
@@ -688,7 +692,7 @@ <h3 id="list-of-platforms">List Of Platforms</h3>
688692
<h3 id="default-profiles">Default Profiles</h3>
689693
<p>The default user configuration includes two compiler profiles:</p>
690694
<ul>
691-
<li><strong>g++</strong>: GNU C++ compiler (with alias "mingw")</li>
695+
<li><strong>g++</strong>: GNU c++ compiler (with alias "mingw")</li>
692696
<li><strong>vs2022_v17+</strong>: Visual Studio 2022 compiler (with aliases "msvc1930+", "msvc")</li>
693697
</ul>
694698
<h3 id="specifying-platformprofile-dependent-settings">Specifying Platform/Profile Dependent Settings</h3>
@@ -706,7 +710,7 @@ <h3 id="specifying-platformprofile-dependent-settings">Specifying Platform/Profi
706710
<div class="language-yaml highlight"><pre><span></span><code><span id="__span-3-1"><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a><span class="nt">OverrideCompileFlags</span><span class="p">:</span>
707711
</span><span id="__span-3-2"><a id="__codelineno-3-2" name="__codelineno-3-2" href="#__codelineno-3-2"></a><span class="w"> </span><span class="nt">Windows</span><span class="p">:</span>
708712
</span><span id="__span-3-3"><a id="__codelineno-3-3" name="__codelineno-3-3" href="#__codelineno-3-3"></a><span class="w"> </span><span class="s">&quot;g++&quot;</span><span class="p p-Indicator">:</span>
709-
</span><span id="__span-3-4"><a id="__codelineno-3-4" name="__codelineno-3-4" href="#__codelineno-3-4"></a><span class="w"> </span><span class="nt">Flags</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;-O2&quot;</span>
713+
</span><span id="__span-3-4"><a id="__codelineno-3-4" name="__codelineno-3-4" href="#__codelineno-3-4"></a><span class="w"> </span><span class="nt">Flags</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;-O2</span><span class="nv"> </span><span class="s">-Wall&quot;</span>
710714
</span><span id="__span-3-5"><a id="__codelineno-3-5" name="__codelineno-3-5" href="#__codelineno-3-5"></a><span class="w"> </span><span class="s">&quot;msvc&quot;</span><span class="p p-Indicator">:</span>
711715
</span><span id="__span-3-6"><a id="__codelineno-3-6" name="__codelineno-3-6" href="#__codelineno-3-6"></a><span class="w"> </span><span class="nt">Flags</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;/O2&quot;</span>
712716
</span><span id="__span-3-7"><a id="__codelineno-3-7" name="__codelineno-3-7" href="#__codelineno-3-7"></a><span class="w"> </span><span class="nt">Linux</span><span class="p">:</span>
@@ -723,17 +727,19 @@ <h3 id="specifying-platformprofile-dependent-settings">Specifying Platform/Profi
723727
<p class="admonition-title">Important</p>
724728
<p>DefaultPlatform and DefaultProfile settings are not additive. For example:
725729
<div class="language-yaml highlight"><pre><span></span><code><span id="__span-4-1"><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a><span class="nt">OverrideCompileFlags</span><span class="p">:</span>
726-
</span><span id="__span-4-2"><a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a><span class="w"> </span><span class="nt">DefaultProfile</span><span class="p">:</span>
727-
</span><span id="__span-4-3"><a id="__codelineno-4-3" name="__codelineno-4-3" href="#__codelineno-4-3"></a><span class="w"> </span><span class="nt">Flags</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;-Wall&quot;</span>
728-
</span><span id="__span-4-4"><a id="__codelineno-4-4" name="__codelineno-4-4" href="#__codelineno-4-4"></a><span class="w"> </span><span class="s">&quot;g++&quot;</span><span class="p p-Indicator">:</span>
729-
</span><span id="__span-4-5"><a id="__codelineno-4-5" name="__codelineno-4-5" href="#__codelineno-4-5"></a><span class="w"> </span><span class="nt">Flags</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;-O2&quot;</span>
730+
</span><span id="__span-4-2"><a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a><span class="w"> </span><span class="nt">DefaultPlatform</span><span class="p">:</span>
731+
</span><span id="__span-4-3"><a id="__codelineno-4-3" name="__codelineno-4-3" href="#__codelineno-4-3"></a><span class="w"> </span><span class="nt">DefaultProfile</span><span class="p">:</span>
732+
</span><span id="__span-4-4"><a id="__codelineno-4-4" name="__codelineno-4-4" href="#__codelineno-4-4"></a><span class="w"> </span><span class="nt">Flags</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;-Wall&quot;</span>
733+
</span><span id="__span-4-5"><a id="__codelineno-4-5" name="__codelineno-4-5" href="#__codelineno-4-5"></a><span class="w"> </span><span class="s">&quot;g++&quot;</span><span class="p p-Indicator">:</span>
734+
</span><span id="__span-4-6"><a id="__codelineno-4-6" name="__codelineno-4-6" href="#__codelineno-4-6"></a><span class="w"> </span><span class="nt">Flags</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;-O2&quot;</span>
730735
</span></code></pre></div>
731736
When using g++, only <code>-O2</code> will be used.
732-
When using any other profile, only <code>-Wall</code> will be used.</p>
737+
When using any other profile, only <code>-Wall</code> will be used, not <code>-Wall -O2</code>.</p>
733738
</div>
734-
<details class="wip skipping defaultplatform and defaultprofile">
735-
<summary>Wip</summary>
736-
<p>If you have a setting that <strong>only</strong> has DefaultPlatform and DefaultProfile, you can directly specify the settings without listing it under DefaultPlatform and DefaultProfile.</p>
739+
<details>
740+
<summary>Skipping DefaultPlatform and DefaultProfile <strong>(WIP)</strong></summary>
741+
<p>If you have a setting that <strong>only</strong> has DefaultPlatform and DefaultProfile, you can directly
742+
specify the settings without listing it under DefaultPlatform and DefaultProfile.</p>
737743
<p>For example:
738744
<div class="language-yaml highlight"><pre><span></span><code><span id="__span-5-1"><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a><span class="nt">OverrideCompileFlags</span><span class="p">:</span>
739745
</span><span id="__span-5-2"><a id="__codelineno-5-2" name="__codelineno-5-2" href="#__codelineno-5-2"></a><span class="w"> </span><span class="nt">Flags</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;-Wall&quot;</span>

0 commit comments

Comments
 (0)