Skip to content

Commit 8de6ca0

Browse files
polytypicpolytypic
committed
Docs
1 parent 072932f commit 8de6ca0

File tree

2 files changed

+107
-99
lines changed

2 files changed

+107
-99
lines changed

‎index.html

Lines changed: 62 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,14 @@ <h2><a id="contents"></a> <a href="#contents">≡</a> <a href="#contents">Conten
4444
<li><a href="#cppsm-init"><code>cppsm init</code></a></li>
4545
<li><a href="#cppsm-list"><code>cppsm list</code></a></li>
4646
<li><a href="#cppsm-remove"><code>cppsm remove path</code></a></li>
47-
<li><a href="#cppsm-setup"><code>cppsm setup</code></a></li>
47+
<li><a href="#cppsm-setup"><code>cppsm setup</code></a><ul>
48+
<li><a href="#cmake_build_type"><code>CMAKE_BUILD_TYPE=Debug|Release</code></a></li>
49+
<li><a href="#cc"><code>CC=cc|gcc|clang|...</code></a></li>
50+
<li><a href="#cxx"><code>CXX=c++|g++|clang++|...</code></a></li>
51+
<li><a href="#clean"><code>CLEAN=0|1</code></a></li>
52+
<li><a href="#coverage"><code>COVERAGE=0|1</code></a></li>
53+
</ul>
54+
</li>
4855
<li><a href="#cppsm-test"><code>cppsm test</code></a></li>
4956
<li><a href="#cppsm-test-watch"><code>cppsm test-watch</code></a></li>
5057
<li><a href="#cppsm-update"><code>cppsm update</code></a></li>
@@ -70,12 +77,20 @@ <h2><a id="contents"></a> <a href="#contents">≡</a> <a href="#contents">Conten
7077
</li>
7178
<li><a href="#variables">Variables</a><ul>
7279
<li><a href="#ctest_output_on_failure"><code>CTEST_OUTPUT_ON_FAILURE=1|0</code></a></li>
73-
<li><a href="#git_quiet"><code>GIT_QUIET=1|0</code></a></li>
74-
<li><a href="#number_of_processors"><code>NUMBER_OF_PROCESSORS=1|2|...</code></a></li>
75-
<li><a href="#n_parallel_build"><code>N_PARALLEL_BUILD=1|2|...</code></a></li>
76-
<li><a href="#n_parallel_test"><code>N_PARALLEL_TEST=1|2|...</code></a></li>
77-
<li><a href="#n_parallel_update"><code>N_PARALLEL_UPDATE=1|2|...</code></a></li>
78-
<li><a href="#xtrace"><code>XTRACE=0|1</code></a></li>
80+
<li><a href="#quiet"><code>QUIET=1|0</code></a><ul>
81+
<li><a href="#git_quiet"><code>GIT_QUIET=QUIET</code></a></li>
82+
</ul>
83+
</li>
84+
<li><a href="#number_of_processors"><code>NUMBER_OF_PROCESSORS=1|2|...</code></a><ul>
85+
<li><a href="#n_parallel_build"><code>N_PARALLEL_BUILD=NUMBER_OF_PROCESSORS</code></a></li>
86+
<li><a href="#n_parallel_test"><code>N_PARALLEL_TEST=NUMBER_OF_PROCESSORS</code></a></li>
87+
<li><a href="#n_parallel_update"><code>N_PARALLEL_UPDATE=NUMBER_OF_PROCESSORS</code></a></li>
88+
</ul>
89+
</li>
90+
<li><a href="#trace"><code>TRACE=0|1</code></a><ul>
91+
<li><a href="#xtrace"><code>XTRACE=TRACE</code></a></li>
92+
</ul>
93+
</li>
7994
</ul>
8095
</li>
8196
</ul>
@@ -213,31 +228,21 @@ <h4><a id="cppsm-setup"></a> <a href="#contents">≡</a> <a href="#cppsm-setup">
213228
options.</p>
214229
<p>Options:</p>
215230
<ul>
216-
<li><p><code>CMAKE_BUILD_TYPE=Debug|Release</code></p>
217-
<ul>
218-
<li><a target="_blank" href="https://cmake.org/cmake/help/latest/variable/CMAKE_BUILD_TYPE.html">Specifies which configuration to use <i class="fas fa-xs fa-external-link-alt"></i></a>.</li>
219-
</ul>
231+
<li><p><a id="cmake_build_type"></a><a href="#cmake_build_type"><code>CMAKE_BUILD_TYPE=Debug|Release</code></a>
232+
<a target="_blank" href="https://cmake.org/cmake/help/latest/variable/CMAKE_BUILD_TYPE.html">specifies which configuration to use <i class="fas fa-xs fa-external-link-alt"></i></a>.</p>
220233
</li>
221-
<li><p><code>CC=cc|gcc|clang|...</code></p>
222-
<ul>
223-
<li><a target="_blank" href="https://cmake.org/cmake/help/latest/envvar/CC.html">Specifies which C compiler to use <i class="fas fa-xs fa-external-link-alt"></i></a>.</li>
224-
</ul>
234+
<li><p><a id="cc"></a><a href="#cc"><code>CC=cc|gcc|clang|...</code></a>
235+
<a target="_blank" href="https://cmake.org/cmake/help/latest/envvar/CC.html">specifies which C compiler to use <i class="fas fa-xs fa-external-link-alt"></i></a>.</p>
225236
</li>
226-
<li><p><code>CXX=c++|g++|clang++|...</code></p>
227-
<ul>
228-
<li><a target="_blank" href="https://cmake.org/cmake/help/latest/envvar/CXX.html">Specifies which C++ compiler to use <i class="fas fa-xs fa-external-link-alt"></i></a>.</li>
229-
</ul>
237+
<li><p><a id="cxx"></a><a href="#cxx"><code>CXX=c++|g++|clang++|...</code></a>
238+
<a target="_blank" href="https://cmake.org/cmake/help/latest/envvar/CXX.html">Specifies which C++ compiler to use <i class="fas fa-xs fa-external-link-alt"></i></a>.</p>
230239
</li>
231-
<li><p><code>CLEAN=0|1</code></p>
232-
<ul>
233-
<li>Specifies that the build directory should be recreated from scratch.</li>
234-
</ul>
240+
<li><p><a id="clean"></a><a href="#clean"><code>CLEAN=0|1</code></a> specifies that the build directory
241+
should be recreated from scratch.</p>
235242
</li>
236-
<li><p><code>COVERAGE=0|1</code></p>
237-
<ul>
238-
<li>Specifies that the build should be configured to generate coverage
239-
information. Currently this option is only supported on GCC and Clang.</li>
240-
</ul>
243+
<li><p><a id="coverage"></a><a href="#coverage"><code>COVERAGE=0|1</code></a> specifies that the build
244+
should be configured to generate coverage information. Currently this option
245+
is only supported on GCC and Clang.</p>
241246
</li>
242247
</ul>
243248
<h4><a id="cppsm-test"></a> <a href="#contents">≡</a> <a href="#cppsm-test"><code>cppsm test</code></a></h4>
@@ -327,32 +332,37 @@ <h3><a id="ctest_output_on_failure"></a> <a href="#contents">≡</a> <a href="#c
327332
<p>By default CTest is configured to
328333
<a target="_blank" href="https://cmake.org/cmake/help/latest/envvar/CTEST_OUTPUT_ON_FAILURE.html">log output in case a test fails <i class="fas fa-xs fa-external-link-alt"></i></a>.
329334
Set <code>CTEST_OUTPUT_ON_FAILURE=0</code> explicitly to override the default.</p>
330-
<h3><a id="git_quiet"></a> <a href="#contents">≡</a> <a href="#git_quiet"><code>GIT_QUIET=1|0</code></a></h3>
331-
<p>By default <a target="_blank" href="https://git-scm.com/">Git <i class="fas fa-xs fa-external-link-alt"></i></a> commands are invoked with the <code>--quiet</code>
332-
flag to reduce noise. Set <code>GIT_QUIET=0</code> to see git command output.</p>
335+
<h3><a id="quiet"></a> <a href="#contents">≡</a> <a href="#quiet"><code>QUIET=1|0</code></a></h3>
336+
<p>By default various commands are invoked with quiet flags to reduce noise. Set
337+
<code>QUIET=0</code> explicitly to see more output from various commands.</p>
338+
<ul>
339+
<li><a id="git_quiet"></a><a href="#git_quiet"><code>GIT_QUIET=QUIET</code></a> controls <code>--quiet</code> flag
340+
for <a target="_blank" href="https://git-scm.com/">Git <i class="fas fa-xs fa-external-link-alt"></i></a> commands.</li>
341+
</ul>
333342
<h3><a id="number_of_processors"></a> <a href="#contents">≡</a> <a href="#number_of_processors"><code>NUMBER_OF_PROCESSORS=1|2|...</code></a></h3>
334-
<p>By default the number of processors is auto detected and parallelism is set to
335-
match the number of processors. Set <code>NUMBER_OF_PROCESSORS</code> explicitly to desired
336-
number to override the default.</p>
337-
<h3><a id="n_parallel_build"></a> <a href="#contents">≡</a> <a href="#n_parallel_build"><code>N_PARALLEL_BUILD=1|2|...</code></a></h3>
338-
<p>By default builds are performed with level of parallelism set to the
339-
<a href="#number_of_processors"><code>NUMBER_OF_PROCESSORS</code></a>. Set <code>N_PARALLEL_BUILD</code>
340-
explicitly to desired number to override the default.</p>
341-
<h3><a id="n_parallel_test"></a> <a href="#contents">≡</a> <a href="#n_parallel_test"><code>N_PARALLEL_TEST=1|2|...</code></a></h3>
342-
<p>By default tests are run with level of parallelism set to the
343-
<a href="#number_of_processors"><code>NUMBER_OF_PROCESSORS</code></a>. Set <code>N_PARALLEL_TEST</code>
344-
explicitly to desired number to override the default.</p>
345-
<h3><a id="n_parallel_update"></a> <a href="#contents">≡</a> <a href="#n_parallel_update"><code>N_PARALLEL_UPDATE=1|2|...</code></a></h3>
346-
<p>By default
347-
<a target="_blank" href="https://git-scm.com/docs/git-submodule#Documentation/git-submodule.txt---jobsltngt">Git submodule updates <i class="fas fa-xs fa-external-link-alt"></i></a>
348-
are run with level of parallelism set to the
349-
<a href="#number_of_processors"><code>NUMBER_OF_PROCESSORS</code></a>. Set <code>N_PARALLEL_UPDATE</code>
350-
explicitly to desired number to override the default.</p>
351-
<h3><a id="xtrace"></a> <a href="#contents">≡</a> <a href="#xtrace"><code>XTRACE=0|1</code></a></h3>
352-
<p>By default scripts do not
343+
<p>By default the number of processors is auto detected and parallelism is set
344+
based on the number of processors. Set <code>NUMBER_OF_PROCESSORS</code> explicitly to
345+
desired number to override the default.</p>
346+
<ul>
347+
<li><p><a id="n_parallel_build"></a><a href="#n_parallel_build"><code>N_PARALLEL_BUILD=NUMBER_OF_PROCESSORS</code></a>
348+
controls level of build parallelism.</p>
349+
</li>
350+
<li><p><a id="n_parallel_test"></a><a href="#n_parallel_test"><code>N_PARALLEL_TEST=NUMBER_OF_PROCESSORS</code></a>
351+
controls level of test parallelism.</p>
352+
</li>
353+
<li><p><a id="n_parallel_update"></a><a href="#n_parallel_update"><code>N_PARALLEL_UPDATE=NUMBER_OF_PROCESSORS</code></a>
354+
controls level of parallelism for
355+
<a target="_blank" href="https://git-scm.com/docs/git-submodule#Documentation/git-submodule.txt---jobsltngt">Git submodule updates <i class="fas fa-xs fa-external-link-alt"></i></a>.</p>
356+
</li>
357+
</ul>
358+
<h3><a id="trace"></a> <a href="#contents">≡</a> <a href="#trace"><code>TRACE=0|1</code></a></h3>
359+
<p>By default scripts do not output trace information to reduce noise. Set
360+
<code>TRACE=1</code> explicitly to see trace output.</p>
361+
<ul>
362+
<li><a id="xtrace"></a><a href="#xtrace"><code>XTRACE=TRACE</code></a> controls whether to
353363
<a target="_blank" href="https://www.gnu.org/software/bash/manual/bash.html#The-Set-Builtin"><code>set -x</code> <i class="fas fa-xs fa-external-link-alt"></i></a>
354-
to enable Bash xtrace to avoid unnecessary noise. Set <code>XTRACE=1</code> to enable Bash
355-
xtrace.</p>
364+
to enable Bash xtrace.</li>
365+
</ul>
356366

357367
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
358368
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/languages/bash.min.js"></script>

‎index.md

Lines changed: 45 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,11 @@ See [repositories with the `#cppsm` topic](https://github.com/topics/cppsm).
3737
- [`cppsm list`](#cppsm-list)
3838
- [`cppsm remove path`](#cppsm-remove)
3939
- [`cppsm setup`](#cppsm-setup)
40+
- [`CMAKE_BUILD_TYPE=Debug|Release`](#cmake_build_type)
41+
- [`CC=cc|gcc|clang|...`](#cc)
42+
- [`CXX=c++|g++|clang++|...`](#cxx)
43+
- [`CLEAN=0|1`](#clean)
44+
- [`COVERAGE=0|1`](#coverage)
4045
- [`cppsm test`](#cppsm-test)
4146
- [`cppsm test-watch`](#cppsm-test-watch)
4247
- [`cppsm update`](#cppsm-update)
@@ -52,12 +57,14 @@ See [repositories with the `#cppsm` topic](https://github.com/topics/cppsm).
5257
- [`INSTALL_WAIT=0|1`](#install_wait)
5358
- [Variables](#variables)
5459
- [`CTEST_OUTPUT_ON_FAILURE=1|0`](#ctest_output_on_failure)
55-
- [`GIT_QUIET=1|0`](#git_quiet)
60+
- [`QUIET=1|0`](#quiet)
61+
- [`GIT_QUIET=QUIET`](#git_quiet)
5662
- [`NUMBER_OF_PROCESSORS=1|2|...`](#number_of_processors)
57-
- [`N_PARALLEL_BUILD=1|2|...`](#n_parallel_build)
58-
- [`N_PARALLEL_TEST=1|2|...`](#n_parallel_test)
59-
- [`N_PARALLEL_UPDATE=1|2|...`](#n_parallel_update)
60-
- [`XTRACE=0|1`](#xtrace)
63+
- [`N_PARALLEL_BUILD=NUMBER_OF_PROCESSORS`](#n_parallel_build)
64+
- [`N_PARALLEL_TEST=NUMBER_OF_PROCESSORS`](#n_parallel_test)
65+
- [`N_PARALLEL_UPDATE=NUMBER_OF_PROCESSORS`](#n_parallel_update)
66+
- [`TRACE=0|1`](#trace)
67+
- [`XTRACE=TRACE`](#xtrace)
6168

6269
## <a id="project-structure"></a> [≡](#contents) [Project structure](#project-structure)
6370

@@ -273,25 +280,21 @@ options.
273280

274281
Options:
275282

276-
- `CMAKE_BUILD_TYPE=Debug|Release`
283+
- <a id="cmake_build_type"></a>[`CMAKE_BUILD_TYPE=Debug|Release`](#cmake_build_type)
284+
[specifies which configuration to use](https://cmake.org/cmake/help/latest/variable/CMAKE_BUILD_TYPE.html).
277285

278-
- [Specifies which configuration to use](https://cmake.org/cmake/help/latest/variable/CMAKE_BUILD_TYPE.html).
286+
- <a id="cc"></a>[`CC=cc|gcc|clang|...`](#cc)
287+
[specifies which C compiler to use](https://cmake.org/cmake/help/latest/envvar/CC.html).
279288

280-
- `CC=cc|gcc|clang|...`
289+
- <a id="cxx"></a>[`CXX=c++|g++|clang++|...`](#cxx)
290+
[Specifies which C++ compiler to use](https://cmake.org/cmake/help/latest/envvar/CXX.html).
281291

282-
- [Specifies which C compiler to use](https://cmake.org/cmake/help/latest/envvar/CC.html).
292+
- <a id="clean"></a>[`CLEAN=0|1`](#clean) specifies that the build directory
293+
should be recreated from scratch.
283294

284-
- `CXX=c++|g++|clang++|...`
285-
286-
- [Specifies which C++ compiler to use](https://cmake.org/cmake/help/latest/envvar/CXX.html).
287-
288-
- `CLEAN=0|1`
289-
290-
- Specifies that the build directory should be recreated from scratch.
291-
292-
- `COVERAGE=0|1`
293-
- Specifies that the build should be configured to generate coverage
294-
information. Currently this option is only supported on GCC and Clang.
295+
- <a id="coverage"></a>[`COVERAGE=0|1`](#coverage) specifies that the build
296+
should be configured to generate coverage information. Currently this option
297+
is only supported on GCC and Clang.
295298

296299
#### <a id="cppsm-test"></a> [≡](#contents) [`cppsm test`](#cppsm-test)
297300

@@ -410,40 +413,35 @@ By default CTest is configured to
410413
[log output in case a test fails](https://cmake.org/cmake/help/latest/envvar/CTEST_OUTPUT_ON_FAILURE.html).
411414
Set `CTEST_OUTPUT_ON_FAILURE=0` explicitly to override the default.
412415

413-
### <a id="git_quiet"></a> [≡](#contents) [`GIT_QUIET=1|0`](#git_quiet)
416+
### <a id="quiet"></a> [≡](#contents) [`QUIET=1|0`](#quiet)
414417

415-
By default [Git](https://git-scm.com/) commands are invoked with the `--quiet`
416-
flag to reduce noise. Set `GIT_QUIET=0` to see git command output.
418+
By default various commands are invoked with quiet flags to reduce noise. Set
419+
`QUIET=0` explicitly to see more output from various commands.
417420

418-
### <a id="number_of_processors"></a> [≡](#contents) [`NUMBER_OF_PROCESSORS=1|2|...`](#number_of_processors)
419-
420-
By default the number of processors is auto detected and parallelism is set to
421-
match the number of processors. Set `NUMBER_OF_PROCESSORS` explicitly to desired
422-
number to override the default.
421+
- <a id="git_quiet"></a>[`GIT_QUIET=QUIET`](#git_quiet) controls `--quiet` flag
422+
for [Git](https://git-scm.com/) commands.
423423

424-
### <a id="n_parallel_build"></a> [≡](#contents) [`N_PARALLEL_BUILD=1|2|...`](#n_parallel_build)
424+
### <a id="number_of_processors"></a> [≡](#contents) [`NUMBER_OF_PROCESSORS=1|2|...`](#number_of_processors)
425425

426-
By default builds are performed with level of parallelism set to the
427-
[`NUMBER_OF_PROCESSORS`](#number_of_processors). Set `N_PARALLEL_BUILD`
428-
explicitly to desired number to override the default.
426+
By default the number of processors is auto detected and parallelism is set
427+
based on the number of processors. Set `NUMBER_OF_PROCESSORS` explicitly to
428+
desired number to override the default.
429429

430-
### <a id="n_parallel_test"></a> [≡](#contents) [`N_PARALLEL_TEST=1|2|...`](#n_parallel_test)
430+
- <a id="n_parallel_build"></a>[`N_PARALLEL_BUILD=NUMBER_OF_PROCESSORS`](#n_parallel_build)
431+
controls level of build parallelism.
431432

432-
By default tests are run with level of parallelism set to the
433-
[`NUMBER_OF_PROCESSORS`](#number_of_processors). Set `N_PARALLEL_TEST`
434-
explicitly to desired number to override the default.
433+
- <a id="n_parallel_test"></a>[`N_PARALLEL_TEST=NUMBER_OF_PROCESSORS`](#n_parallel_test)
434+
controls level of test parallelism.
435435

436-
### <a id="n_parallel_update"></a> [≡](#contents) [`N_PARALLEL_UPDATE=1|2|...`](#n_parallel_update)
436+
- <a id="n_parallel_update"></a>[`N_PARALLEL_UPDATE=NUMBER_OF_PROCESSORS`](#n_parallel_update)
437+
controls level of parallelism for
438+
[Git submodule updates](https://git-scm.com/docs/git-submodule#Documentation/git-submodule.txt---jobsltngt).
437439

438-
By default
439-
[Git submodule updates](https://git-scm.com/docs/git-submodule#Documentation/git-submodule.txt---jobsltngt)
440-
are run with level of parallelism set to the
441-
[`NUMBER_OF_PROCESSORS`](#number_of_processors). Set `N_PARALLEL_UPDATE`
442-
explicitly to desired number to override the default.
440+
### <a id="trace"></a> [≡](#contents) [`TRACE=0|1`](#trace)
443441

444-
### <a id="xtrace"></a> [≡](#contents) [`XTRACE=0|1`](#xtrace)
442+
By default scripts do not output trace information to reduce noise. Set
443+
`TRACE=1` explicitly to see trace output.
445444

446-
By default scripts do not
447-
[`set -x`](https://www.gnu.org/software/bash/manual/bash.html#The-Set-Builtin)
448-
to enable Bash xtrace to avoid unnecessary noise. Set `XTRACE=1` to enable Bash
449-
xtrace.
445+
- <a id="xtrace"></a>[`XTRACE=TRACE`](#xtrace) controls whether to
446+
[`set -x`](https://www.gnu.org/software/bash/manual/bash.html#The-Set-Builtin)
447+
to enable Bash xtrace.

0 commit comments

Comments
 (0)