Skip to content

Commit 94ed539

Browse files
coder137coder137
committed
deploy: 99bcad0 
1 parent 64c6c87 commit 94ed539

File tree

11 files changed

+23
-25
lines changed

11 files changed

+23
-25
lines changed

‎.doctrees/environment.pickle

-7.23 KB
Binary file not shown.

‎.doctrees/user_api/environment.doctree

491 Bytes
Binary file not shown.

‎.doctrees/user_api/register.doctree

234 Bytes
Binary file not shown.

‎.doctrees/user_api/target_utils.doctree

1.93 KB
Binary file not shown.

‎.doctrees/user_api/toolchain.doctree

-1.39 KB
Binary file not shown.

‎objects.inv

-127 Bytes
Binary file not shown.

‎searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎user_api/environment.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -422,9 +422,9 @@ <h2>host_os.h<a class="headerlink" href="#host-os-h" title="Permalink to this he
422422
<dt class="sig sig-object cpp" id="_CPPv4N7buildcc3env7is_unixEv">
423423
<span id="_CPPv3N7buildcc3env7is_unixEv"></span><span id="_CPPv2N7buildcc3env7is_unixEv"></span><span id="buildcc::env::is_unixCE"></span><span class="target" id="namespacebuildcc_1_1env_1a8ce275d550c72c359b0836ea948e08e4"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-prename descclassname"><span class="n"><span class="pre">buildcc</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">env</span></span><span class="p"><span class="pre">::</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">is_unix</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N7buildcc3env7is_unixEv" title="Permalink to this definition"></a><br/></dt>
424424
<dd></dd></dl>
425-
<dl class="cpp enum">
425+
<dl class="cpp enum-class">
426426
<dt class="sig sig-object cpp" id="_CPPv4N7buildcc4OsIdE">
427-
<span id="_CPPv3N7buildcc4OsIdE"></span><span id="_CPPv2N7buildcc4OsIdE"></span><span class="target" id="namespacebuildcc_1ac02cca905c5b3a1776eea033970a103f"></span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><span class="sig-prename descclassname"><span class="n"><span class="pre">buildcc</span></span><span class="p"><span class="pre">::</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">OsId</span></span></span><a class="headerlink" href="#_CPPv4N7buildcc4OsIdE" title="Permalink to this definition"></a><br/></dt>
427+
<span id="_CPPv3N7buildcc4OsIdE"></span><span id="_CPPv2N7buildcc4OsIdE"></span><span class="target" id="namespacebuildcc_1ac02cca905c5b3a1776eea033970a103f"></span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-prename descclassname"><span class="n"><span class="pre">buildcc</span></span><span class="p"><span class="pre">::</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">OsId</span></span></span><a class="headerlink" href="#_CPPv4N7buildcc4OsIdE" title="Permalink to this definition"></a><br/></dt>
428428
<dd><p><em>Values:</em></p>
429429
<dl class="cpp enumerator">
430430
<dt class="sig sig-object cpp" id="_CPPv4N7buildcc4OsId5LinuxE">
@@ -483,9 +483,9 @@ <h2>host_os_util.h<a class="headerlink" href="#host-os-util-h" title="Permalink
483483
</div>
484484
<div class="section" id="task-state-h">
485485
<h2>task_state.h<a class="headerlink" href="#task-state-h" title="Permalink to this headline"></a></h2>
486-
<dl class="cpp enum">
486+
<dl class="cpp enum-class">
487487
<dt class="sig sig-object cpp" id="_CPPv4N7buildcc3env9TaskStateE">
488-
<span id="_CPPv3N7buildcc3env9TaskStateE"></span><span id="_CPPv2N7buildcc3env9TaskStateE"></span><span class="target" id="namespacebuildcc_1_1env_1a0108e86ddf0a956c08ec5c3f9cc13257"></span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><span class="sig-prename descclassname"><span class="n"><span class="pre">buildcc</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">env</span></span><span class="p"><span class="pre">::</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">TaskState</span></span></span><a class="headerlink" href="#_CPPv4N7buildcc3env9TaskStateE" title="Permalink to this definition"></a><br/></dt>
488+
<span id="_CPPv3N7buildcc3env9TaskStateE"></span><span id="_CPPv2N7buildcc3env9TaskStateE"></span><span class="target" id="namespacebuildcc_1_1env_1a0108e86ddf0a956c08ec5c3f9cc13257"></span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-prename descclassname"><span class="n"><span class="pre">buildcc</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">env</span></span><span class="p"><span class="pre">::</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">TaskState</span></span></span><a class="headerlink" href="#_CPPv4N7buildcc3env9TaskStateE" title="Permalink to this definition"></a><br/></dt>
489489
<dd><p><em>Values:</em></p>
490490
<dl class="cpp enumerator">
491491
<dt class="sig sig-object cpp" id="_CPPv4N7buildcc3env9TaskState7SUCCESSE">

‎user_api/register.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -340,9 +340,9 @@ <h2>test_info.h<a class="headerlink" href="#test-info-h" title="Permalink to thi
340340
<span id="_CPPv3N7buildcc10TestOutputE"></span><span id="_CPPv2N7buildcc10TestOutputE"></span><span id="buildcc::TestOutput"></span><span class="target" id="structbuildcc_1_1TestOutput"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-prename descclassname"><span class="n"><span class="pre">buildcc</span></span><span class="p"><span class="pre">::</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">TestOutput</span></span></span><a class="headerlink" href="#_CPPv4N7buildcc10TestOutputE" title="Permalink to this definition"></a><br/></dt>
341341
<dd><div class="breathe-sectiondef docutils container">
342342
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-types">Public Types</p>
343-
<dl class="cpp enum">
343+
<dl class="cpp enum-class">
344344
<dt class="sig sig-object cpp" id="_CPPv4N7buildcc10TestOutput4TypeE">
345-
<span id="_CPPv3N7buildcc10TestOutput4TypeE"></span><span id="_CPPv2N7buildcc10TestOutput4TypeE"></span><span class="target" id="structbuildcc_1_1TestOutput_1a355078b325968c59dc3c812f2d259233"></span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Type</span></span></span><a class="headerlink" href="#_CPPv4N7buildcc10TestOutput4TypeE" title="Permalink to this definition"></a><br/></dt>
345+
<span id="_CPPv3N7buildcc10TestOutput4TypeE"></span><span id="_CPPv2N7buildcc10TestOutput4TypeE"></span><span class="target" id="structbuildcc_1_1TestOutput_1a355078b325968c59dc3c812f2d259233"></span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Type</span></span></span><a class="headerlink" href="#_CPPv4N7buildcc10TestOutput4TypeE" title="Permalink to this definition"></a><br/></dt>
346346
<dd><p><em>Values:</em></p>
347347
<dl class="cpp enumerator">
348348
<dt class="sig sig-object cpp" id="_CPPv4N7buildcc10TestOutput4Type16DefaultBehaviourE">

‎user_api/target_utils.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -233,9 +233,9 @@ <h1>Target Utils<a class="headerlink" href="#target-utils" title="Permalink to t
233233
<p>Commonly used Utils (Classes / Structs) for <strong>Generator</strong>, <strong>TargetInfo</strong> and <strong>Target</strong> classes.</p>
234234
<div class="section" id="target-file-ext-h">
235235
<h2>target_file_ext.h<a class="headerlink" href="#target-file-ext-h" title="Permalink to this headline"></a></h2>
236-
<dl class="cpp enum">
236+
<dl class="cpp enum-class">
237237
<dt class="sig sig-object cpp" id="_CPPv4N7buildcc13TargetFileExtE">
238-
<span id="_CPPv3N7buildcc13TargetFileExtE"></span><span id="_CPPv2N7buildcc13TargetFileExtE"></span><span class="target" id="namespacebuildcc_1a04dc26919a226c9db705bb7db80d79b4"></span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><span class="sig-prename descclassname"><span class="n"><span class="pre">buildcc</span></span><span class="p"><span class="pre">::</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">TargetFileExt</span></span></span><a class="headerlink" href="#_CPPv4N7buildcc13TargetFileExtE" title="Permalink to this definition"></a><br/></dt>
238+
<span id="_CPPv3N7buildcc13TargetFileExtE"></span><span id="_CPPv2N7buildcc13TargetFileExtE"></span><span class="target" id="namespacebuildcc_1a04dc26919a226c9db705bb7db80d79b4"></span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-prename descclassname"><span class="n"><span class="pre">buildcc</span></span><span class="p"><span class="pre">::</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">TargetFileExt</span></span></span><a class="headerlink" href="#_CPPv4N7buildcc13TargetFileExtE" title="Permalink to this definition"></a><br/></dt>
239239
<dd><p><em>Values:</em></p>
240240
<dl class="cpp enumerator">
241241
<dt class="sig sig-object cpp" id="_CPPv4N7buildcc13TargetFileExt3AsmE">
@@ -266,9 +266,9 @@ <h2>target_file_ext.h<a class="headerlink" href="#target-file-ext-h" title="Perm
266266
</div>
267267
<div class="section" id="target-type-h">
268268
<h2>target_type.h<a class="headerlink" href="#target-type-h" title="Permalink to this headline"></a></h2>
269-
<dl class="cpp enum">
269+
<dl class="cpp enum-class">
270270
<dt class="sig sig-object cpp" id="_CPPv4N7buildcc10TargetTypeE">
271-
<span id="_CPPv3N7buildcc10TargetTypeE"></span><span id="_CPPv2N7buildcc10TargetTypeE"></span><span class="target" id="namespacebuildcc_1ac8271f3e908025aa01ad616aa51229c4"></span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><span class="sig-prename descclassname"><span class="n"><span class="pre">buildcc</span></span><span class="p"><span class="pre">::</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">TargetType</span></span></span><a class="headerlink" href="#_CPPv4N7buildcc10TargetTypeE" title="Permalink to this definition"></a><br/></dt>
271+
<span id="_CPPv3N7buildcc10TargetTypeE"></span><span id="_CPPv2N7buildcc10TargetTypeE"></span><span class="target" id="namespacebuildcc_1ac8271f3e908025aa01ad616aa51229c4"></span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-prename descclassname"><span class="n"><span class="pre">buildcc</span></span><span class="p"><span class="pre">::</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">TargetType</span></span></span><a class="headerlink" href="#_CPPv4N7buildcc10TargetTypeE" title="Permalink to this definition"></a><br/></dt>
272272
<dd><p><em>Values:</em></p>
273273
<dl class="cpp enumerator">
274274
<dt class="sig sig-object cpp" id="_CPPv4N7buildcc10TargetType10ExecutableE">

‎user_api/toolchain.html

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -238,9 +238,9 @@ <h2>toolchain.h<a class="headerlink" href="#toolchain-h" title="Permalink to thi
238238
<dd><p>Subclassed by <a class="reference internal" href="#classbuildcc_1_1Toolchain__gcc"><span class="std std-ref">buildcc::Toolchain_gcc</span></a>, <a class="reference internal" href="#classbuildcc_1_1Toolchain__mingw"><span class="std std-ref">buildcc::Toolchain_mingw</span></a>, <a class="reference internal" href="#classbuildcc_1_1Toolchain__msvc"><span class="std std-ref">buildcc::Toolchain_msvc</span></a></p>
239239
<div class="breathe-sectiondef docutils container">
240240
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-types">Public Types</p>
241-
<dl class="cpp enum">
241+
<dl class="cpp enum-class">
242242
<dt class="sig sig-object cpp" id="_CPPv4N7buildcc9Toolchain2IdE">
243-
<span id="_CPPv3N7buildcc9Toolchain2IdE"></span><span id="_CPPv2N7buildcc9Toolchain2IdE"></span><span class="target" id="classbuildcc_1_1Toolchain_1a089e7f8f80c2850803db769395c1735e"></span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Id</span></span></span><a class="headerlink" href="#_CPPv4N7buildcc9Toolchain2IdE" title="Permalink to this definition"></a><br/></dt>
243+
<span id="_CPPv3N7buildcc9Toolchain2IdE"></span><span id="_CPPv2N7buildcc9Toolchain2IdE"></span><span class="target" id="classbuildcc_1_1Toolchain_1a089e7f8f80c2850803db769395c1735e"></span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Id</span></span></span><a class="headerlink" href="#_CPPv4N7buildcc9Toolchain2IdE" title="Permalink to this definition"></a><br/></dt>
244244
<dd><p><em>Values:</em></p>
245245
<dl class="cpp enumerator">
246246
<dt class="sig sig-object cpp" id="_CPPv4N7buildcc9Toolchain2Id3GccE">
@@ -353,38 +353,37 @@ <h2>toolchain_verify.h<a class="headerlink" href="#toolchain-verify-h" title="Pe
353353
<dt class="sig sig-object cpp" id="_CPPv4N7buildcc21VerifyToolchainConfigE">
354354
<span id="_CPPv3N7buildcc21VerifyToolchainConfigE"></span><span id="_CPPv2N7buildcc21VerifyToolchainConfigE"></span><span id="buildcc::VerifyToolchainConfig"></span><span class="target" id="structbuildcc_1_1VerifyToolchainConfig"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-prename descclassname"><span class="n"><span class="pre">buildcc</span></span><span class="p"><span class="pre">::</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">VerifyToolchainConfig</span></span></span><a class="headerlink" href="#_CPPv4N7buildcc21VerifyToolchainConfigE" title="Permalink to this definition"></a><br/></dt>
355355
<dd><p>Configure the behaviour of <a class="reference internal" href="#classbuildcc_1_1ToolchainVerify_1ae775d453c29ce4ca1a33a4dc7f2ab1af"><span class="std std-ref">Toolchain::Verify</span></a> API. By default searches the directories mentioned in the ENV{PATH} variable to find the toolchain. </p>
356-
<p><dl class="field-list simple">
357-
<dt class="field-odd">param absolute_search_paths</dt>
356+
<dl class="field-list simple">
357+
<dt class="field-odd">Param absolute_search_paths</dt>
358358
<dd class="field-odd"><p>absolute_search_paths expect directories that are iterated for exact toolchain matches </p>
359359
</dd>
360-
<dt class="field-even">param env_vars</dt>
360+
<dt class="field-even">Param env_vars</dt>
361361
<dd class="field-even"><p><p>env_vars contain paths that are seperated by OS delimiter. These are converted to paths and searched similarly to absolute_search_paths</p>
362362
<p>NOTE: env_vars must contain single absolute paths or multiple absolute paths seperated by OS delimiter</p>
363363
<p>Example: [Windows] “absolute_path_1;absolute_path_2;…”</p>
364364
<p>Example: [Linux] “absolute_path_1:absolute_path_2:…”</p>
365365
</p>
366366
</dd>
367-
<dt class="field-odd">param compiler_version</dt>
367+
<dt class="field-odd">Param compiler_version</dt>
368368
<dd class="field-odd"><p><p>Optionally supply a compiler version if multiple toolchains of the same family/id are installed</p>
369369
<p>Example: [GCC/MinGW/Clang] {compiler} -dumpversion</p>
370370
<p>Example: [MSVC] getenv(VSCMD_VER)</p>
371371
<p>For [MSVC] make sure to use</p>
372372
<code class="docutils literal notranslate"><span class="pre">vcvarsall.bat</span> <span class="pre">{flavour}</span></code> to activate your toolchain </p>
373373
</dd>
374-
<dt class="field-even">param target_arch</dt>
374+
<dt class="field-even">Param target_arch</dt>
375375
<dd class="field-even"><p><p>Optionally supply a target architecture if multiple toolchains of the same family/id are installed but target different platforms</p>
376376
<p>Example: [GCC/MinGW/Clang] {compiler} -dumpmachine</p>
377377
<p>Example: [MSVC] getenv(VSCMD_ARG_HOST_ARCH) + getenv(VSCMD_ARG_TGT_ARCH)</p>
378378
<p>For [MSVC] make sure to use</p>
379379
<code class="docutils literal notranslate"><span class="pre">vcvarsall.bat</span> <span class="pre">{flavour}</span></code> to activate your toolchain </p>
380380
</dd>
381-
<dt class="field-odd">param update</dt>
381+
<dt class="field-odd">Param update</dt>
382382
<dd class="field-odd"><p><p>Updates the toolchain with absolute paths once verified</p>
383383
<p>If multiple toolchains are found, uses the first in the list</p>
384384
</p>
385385
</dd>
386386
</dl>
387-
</p>
388387
<div class="breathe-sectiondef docutils container">
389388
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p>
390389
<dl class="cpp var">
@@ -413,20 +412,19 @@ <h2>toolchain_verify.h<a class="headerlink" href="#toolchain-verify-h" title="Pe
413412
<dt class="sig sig-object cpp" id="_CPPv4N7buildcc17VerifiedToolchainE">
414413
<span id="_CPPv3N7buildcc17VerifiedToolchainE"></span><span id="_CPPv2N7buildcc17VerifiedToolchainE"></span><span id="buildcc::VerifiedToolchain"></span><span class="target" id="structbuildcc_1_1VerifiedToolchain"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-prename descclassname"><span class="n"><span class="pre">buildcc</span></span><span class="p"><span class="pre">::</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">VerifiedToolchain</span></span></span><a class="headerlink" href="#_CPPv4N7buildcc17VerifiedToolchainE" title="Permalink to this definition"></a><br/></dt>
415414
<dd><p>Verified <a class="reference internal" href="#classbuildcc_1_1Toolchain"><span class="std std-ref">Toolchain</span></a> information. </p>
416-
<p><dl class="field-list simple">
417-
<dt class="field-odd">param path</dt>
415+
<dl class="field-list simple">
416+
<dt class="field-odd">Param path</dt>
418417
<dd class="field-odd"><p><p>Absolute host path where ALL the toolchain executables are found</p>
419418
<p>NOTE: All the</p>
420419
<a class="reference internal" href="#classbuildcc_1_1Toolchain"><span class="std std-ref">Toolchain</span></a> executables must be found in a single folder. </p>
421420
</dd>
422-
<dt class="field-even">param compiler_version</dt>
421+
<dt class="field-even">Param compiler_version</dt>
423422
<dd class="field-even"><p>Compiler version of the verified toolchain </p>
424423
</dd>
425-
<dt class="field-odd">param target_arch</dt>
424+
<dt class="field-odd">Param target_arch</dt>
426425
<dd class="field-odd"><p><a class="reference internal" href="target.html#classbuildcc_1_1Target"><span class="std std-ref">Target</span></a> architecture of the verified toolchain </p>
427426
</dd>
428427
</dl>
429-
</p>
430428
<div class="breathe-sectiondef docutils container">
431429
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p>
432430
<dl class="cpp function">

0 commit comments

Comments
 (0)