deploy: fb6761d

Author: alandefreitas

cpp-actions/develop/actions/b2-workflow.html

@@ -506,6 +506,11 @@ <h2 id="_input_parameters"><a class="anchor" href="#_input_parameters"></a>Input
 <td class="tableblock halign-left valign-top"><p class="tableblock">Default</p></td>
 </tr>
 <tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>trace-commands</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Trace commands executed by the workflow.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
+</tr>
+<tr>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>source-dir</code></p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">The boost source directory.</p>
 <p class="tableblock">This path will be used to build and install <code>B2</code> for the workflow
@@ -519,7 +524,7 @@ <h2 id="_input_parameters"><a class="anchor" href="#_input_parameters"></a>Input
 <p class="tableblock">The build directory for the project root will be computed by concatenating the value of the
 --build-dir option, the project name specified in Jamroot, and the build dir specified in Jamroot
 (or bin, if none is specified).</p>
-<p class="tableblock">The option is primarily useful when building from read-only media, when you can’t modify Jamroot.</p></td>
+<p class="tableblock">The option is primarily useful when building from read-only media, when you can&#8217;t modify Jamroot.</p></td>
 <td class="tableblock halign-left valign-top"></td>
 </tr>
 <tr>
@@ -531,9 +536,9 @@ <h2 id="_input_parameters"><a class="anchor" href="#_input_parameters"></a>Input
 </tr>
 <tr>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>cxxflags</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Flags to be used with the C++ compiler.
-If the input is not specified, the action will use the flags defined by the environment variable <code>CXXFLAGS</code>.
-If the environment variable is not specified, the action will use the default flags as identified by B2.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Flags to be used with the C++ compiler.</p>
+<p class="tableblock">If the input is not specified, the action will use the flags defined by the environment variable <code>CXXFLAGS</code>.</p>
+<p class="tableblock">If the environment variable is not specified, the action will use the default flags as identified by B2.</p></td>
 <td class="tableblock halign-left valign-top"></td>
 </tr>
 <tr>
@@ -684,7 +689,7 @@ <h2 id="_input_parameters"><a class="anchor" href="#_input_parameters"></a>Input
 <td class="tableblock halign-left valign-top"><p class="tableblock">Compresses target paths by abbreviating each component.</p>
 <p class="tableblock">This option is useful to keep paths from becoming longer than the filesystem supports.</p>
 <p class="tableblock">See also the B2 documentation section
-<a href="https://www.boost.org/doc/libs/master/tools/build/doc/html/index.html#bbv2.reference.buildprocess.targetpath">“Target Paths”</a>.</p></td>
+<a href="https://www.boost.org/doc/libs/master/tools/build/doc/html/index.html#bbv2.reference.buildprocess.targetpath">"Target Paths"</a>.</p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td>
 </tr>
 <tr>
@@ -694,7 +699,7 @@ <h2 id="_input_parameters"><a class="anchor" href="#_input_parameters"></a>Input
 <p class="tableblock">This option produces shorter paths than --abbreviate-paths does, but at the cost of making them less
 understandable.</p>
 <p class="tableblock">See also the B2 documentation section
-<a href="https://www.boost.org/doc/libs/master/tools/build/doc/html/index.html#bbv2.reference.buildprocess.targetpath">“Target Paths”</a>.</p></td>
+<a href="https://www.boost.org/doc/libs/master/tools/build/doc/html/index.html#bbv2.reference.buildprocess.targetpath">"Target Paths"</a>.</p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
 </tr>
 <tr>
@@ -712,7 +717,7 @@ <h2 id="_input_parameters"><a class="anchor" href="#_input_parameters"></a>Input
 <tr>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>stop-on-error</code></p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">Equivalent to the <code>-q</code> option.</p>
-<p class="tableblock">Stop at the first error, as opposed to continuing to build targets that don’t depend on the failed ones.</p></td>
+<p class="tableblock">Stop at the first error, as opposed to continuing to build targets that don&#8217;t depend on the failed ones.</p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
 </tr>
 <tr>
@@ -769,8 +774,8 @@ <h2 id="_input_parameters"><a class="anchor" href="#_input_parameters"></a>Input
 </tr>
 <tr>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>define</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Additional macro definitions for C and C++ compilers.
-The string should be either SYMBOL or SYMBOL=VALUE.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Additional macro definitions for C and C++ compilers.</p>
+<p class="tableblock">The string should be either SYMBOL or SYMBOL=VALUE.</p></td>
 <td class="tableblock halign-left valign-top"></td>
 </tr>
 <tr>
@@ -785,12 +790,7 @@ <h2 id="_input_parameters"><a class="anchor" href="#_input_parameters"></a>Input
 <p class="tableblock">If the input is not specified, the action will use the value defined by the environment variable <code>B2_JOBS</code>.</p>
 <p class="tableblock">If the environment variable is also not specified, the action will use the number of processors available in the
 system.</p></td>
-<td class="tableblock halign-left valign-top"></td>
-</tr>
-<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><code>trace-commands</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Trace commands executed by the workflow.</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>0</code></p></td>
 </tr>
 </tbody>
 </table>

cpp-actions/develop/actions/boost-clone.html

@@ -508,10 +508,14 @@ <h2 id="_input_parameters"><a class="anchor" href="#_input_parameters"></a>Input
 <td class="tableblock halign-left valign-top"><p class="tableblock">Default</p></td>
 </tr>
 <tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>trace-commands</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Trace commands executed by the workflow.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
+</tr>
+<tr>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boost-dir</code></p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">The directory where Boost should be cloned.</p>
-<p class="tableblock">If no value is provided (default), the action will clone boost in a temporary
-directory.</p></td>
+<p class="tableblock">If no value is provided (default), the action will clone boost in a temporary directory.</p></td>
 <td class="tableblock halign-left valign-top"></td>
 </tr>
 <tr>
@@ -525,7 +529,7 @@ <h2 id="_input_parameters"><a class="anchor" href="#_input_parameters"></a>Input
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>patches</code></p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">A list of patches to apply to the boost super-project.</p>
 <p class="tableblock">A patch is a module intended as a Boost library that is not yet part of the super-project.</p>
-<p class="tableblock">Each path will be cloned in the <code>libs</code> directory of the super-project. ⚠️ This parameter is required.</p></td>
+<p class="tableblock">Each path will be cloned in the <code>libs</code> directory of the super-project.</p></td>
 <td class="tableblock halign-left valign-top"></td>
 </tr>
 <tr>
@@ -555,7 +559,8 @@ <h2 id="_input_parameters"><a class="anchor" href="#_input_parameters"></a>Input
 <td class="tableblock halign-left valign-top"><p class="tableblock">Module subdirectory to exclude from scanning.</p>
 <p class="tableblock">Directories that match any of the values in this list will be ignored.</p>
 <p class="tableblock">By default, the action excludes the ['test', 'tests'] directories.</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><code>test tests</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>test</code></p>
+<p class="tableblock"><code>tests</code></p></td>
 </tr>
 <tr>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>scan-modules-ignore</code></p></td>
@@ -596,11 +601,6 @@ <h2 id="_input_parameters"><a class="anchor" href="#_input_parameters"></a>Input
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
 </tr>
 <tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><code>trace-commands</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Trace commands executed by the workflow.</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
-</tr>
-<tr>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>clone-strategy</code></p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">Strategy for obtaining Boost source files.</p>
 <p class="tableblock">- <code>auto</code>: Automatically select the best strategy based on branch type and module count.

cpp-actions/develop/actions/cmake-workflow.html

@@ -566,6 +566,11 @@ <h2 id="_input_parameters"><a class="anchor" href="#_input_parameters"></a>Input
 <td class="tableblock halign-left valign-top"><p class="tableblock">Default</p></td>
 </tr>
 <tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>trace-commands</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Trace commands executed by the workflow.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
+</tr>
+<tr>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>cmake-path</code></p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">Ordered list of candidate paths to the cmake executable.</p>
 <p class="tableblock">Entries follow the same rules as the underlying <code>setup-cmake</code> action:</p>
@@ -674,9 +679,9 @@ <h2 id="_input_parameters"><a class="anchor" href="#_input_parameters"></a>Input
 </tr>
 <tr>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>cxxflags</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Flags to be used with the C++ compiler.
-If the input is not specified, the action will use the flags defined by the environment variable <code>CXXFLAGS</code>.
-If the environment variable is not specified, the action will use the default flags as identified by CMake.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Flags to be used with the C++ compiler.</p>
+<p class="tableblock">If the input is not specified, the action will use the flags defined by the environment variable <code>CXXFLAGS</code>.</p>
+<p class="tableblock">If the environment variable is not specified, the action will use the default flags as identified by CMake.</p></td>
 <td class="tableblock halign-left valign-top"></td>
 </tr>
 <tr>
@@ -774,7 +779,7 @@ <h2 id="_input_parameters"><a class="anchor" href="#_input_parameters"></a>Input
 <p class="tableblock">If the input is not specified, the action will use the value defined by the environment variable <code>CMAKE_JOBS</code>.</p>
 <p class="tableblock">If the environment variable is also not specified, the action will use the number of processors available in the
 system.</p></td>
-<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>0</code></p></td>
 </tr>
 <tr>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>run-tests</code></p></td>
@@ -805,7 +810,7 @@ <h2 id="_input_parameters"><a class="anchor" href="#_input_parameters"></a>Input
 <p class="tableblock">If a test runs longer than this value, it will be killed and marked as failed.</p>
 <p class="tableblock">If the input is not specified, the action will use the value defined by the environment variable <code>CTEST_TEST_TIMEOUT</code>.</p>
 <p class="tableblock">If the environment variable is also not specified, ctest will use its default behavior (no timeout).</p></td>
-<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>0</code></p></td>
 </tr>
 <tr>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>install</code></p></td>
@@ -867,7 +872,7 @@ <h2 id="_input_parameters"><a class="anchor" href="#_input_parameters"></a>Input
 <td class="tableblock halign-left valign-top"><p class="tableblock">Whether the packages generated with CPack should be stored as action artifacts.</p>
 <p class="tableblock">If the input is not specified, the action will use the value defined by the environment variable <code>CMAKE_PACKAGE_ARTIFACT</code>.</p>
 <p class="tableblock">If the environment variable is also not specified, the action will store the packages as artifacts.</p></td>
-<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td>
 </tr>
 <tr>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>package-retention-days</code></p></td>
@@ -879,7 +884,7 @@ <h2 id="_input_parameters"><a class="anchor" href="#_input_parameters"></a>Input
 <td class="tableblock halign-left valign-top"><p class="tableblock">Create github annotations for errors and warnings at all steps.</p>
 <p class="tableblock">If the input is not specified, the action will use the value defined by the environment variable <code>CMAKE_CREATE_ANNOTATIONS</code>.</p>
 <p class="tableblock">If the environment variable is also not specified, the action will create annotations.</p></td>
-<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td>
 </tr>
 <tr>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>ref-source-dir</code></p></td>
@@ -896,11 +901,6 @@ <h2 id="_input_parameters"><a class="anchor" href="#_input_parameters"></a>Input
 <p class="tableblock">In most cases, the default option should be enough.</p></td>
 <td class="tableblock halign-left valign-top"></td>
 </tr>
-<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><code>trace-commands</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Trace commands executed by the workflow.</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
-</tr>
 </tbody>
 </table>
 </div>