diff --git a/index.html b/index.html index 4f9220d..2bd2559 100644 --- a/index.html +++ b/index.html @@ -71,8 +71,9 @@
cppsm setupCMAKE_BUILD_TYPE=Debug|ReleaseCMAKE_GENERATOR=''|'...'CC=cc|gcc|clang|...CXX=c++|g++|clang++|...CMAKE_TOOLCHAIN_FILE=''|'...'CC=cc|gcc|clang|emcc|...CXX=c++|g++|clang++|emcc|...CLEAN=0|1COVERAGE=0|1CMAKE_TOOLCHAIN_FILE=''|'...'
+specifies toolchain file to use .
CC=cc|gcc|clang|emcc|...
specifies which C compiler to use .
CXX=c++|g++|clang++|emcc|...
specifies which C++ compiler to use .
CLEAN=0|1 specifies whether the build directory
@@ -456,17 +465,19 @@
Release builds on various OS
(Linux, OS X, Windows) and compiler configurations
(Clang , GCC ,
-Visual C++ ). Just add your project to
-Travis CI.
+Visual C++ ,
+Emscripten ). Just add your project to Travis CI.
Configuration variables:
CLANG=1|0 specifies whether to build with
+Clang . Set CLANG=0 explicitly to skip building
+with Clang .
CODECOV=0|1 specifies whether a code
coverage test is executed and results are pushed to
Codecov . Set CODECOV=1 explicitly to enable code
coverage.
EMSCRIPTEN=0|1 specifies whether to
+also build with Emscripten . Set EMSCRIPTEN=1
+explicitly to build with Emscripten .
FORMAT_CHECK=1|0 specifies whether
to check that source files are formatted as with
cppsm format. Set FORMAT_CHECK=0 explicitly to disable
the format check.
GCC=1|0 specifies whether to build with
+GCC . Set GCC=0 explicitly to skip building with
+GCC .
INSTALL_WAIT=0|1 specifies whether
installation of additional packages is performed concurrently with builds when
possible. Set INSTALL_WAIT=1 explicitly to wait for installations to
@@ -497,6 +520,16 @@
VS2017=1|0 specifies whether to build with
+Visual C++ 2017. Set VS2017=0
+explicitly to skip building with
+Visual C++ 2017.
VS2019=1|0 specifies whether to build with
+Visual C++ 2019. Set VS2019=0
+explicitly to skip building with
+Visual C++ 2019.
Several environment variables can be set to change the default behavior of one diff --git a/index.md b/index.md index 1e9ef2f..80c1694 100644 --- a/index.md +++ b/index.md @@ -57,8 +57,9 @@ See [repositories with the `#cppsm` topic](https://github.com/topics/cppsm). - [`cppsm setup`](#cppsm-setup) - [`CMAKE_BUILD_TYPE=Debug|Release`](#cmake_build_type) - [`CMAKE_GENERATOR=''|'...'`](#cmake_generator) - - [`CC=cc|gcc|clang|...`](#cc) - - [`CXX=c++|g++|clang++|...`](#cxx) + - [`CMAKE_TOOLCHAIN_FILE=''|'...'`](#cmake_toolchain_file) + - [`CC=cc|gcc|clang|emcc|...`](#cc) + - [`CXX=c++|g++|clang++|emcc|...`](#cxx) - [`CLEAN=0|1`](#clean) - [`COVERAGE=0|1`](#coverage) - [`cppsm test`](#cppsm-test) @@ -75,10 +76,15 @@ See [repositories with the `#cppsm` topic](https://github.com/topics/cppsm). - [`add_conventional_executable_tests(...)`](#add_conventional_executable_tests) - [`add_conventional_library(${LIBRARY_NAME}_${LIBRARY_VERSION})`](#add_conventional_library) - [Travis CI](#travis-ci) + - [`CLANG=1|0`](#clang) - [`CODECOV=0|1`](#codecov) + - [`EMSCRIPTEN=0|1`](#emscripten) - [`FORMAT_CHECK=1|0`](#format_check) + - [`GCC=1|0`](#gcc) - [`INSTALL_WAIT=0|1`](#install_wait) - [`UPGRADE_CHECK=1|0`](#upgrade_check) + - [`VS2017=1|0`](#vs2017) + - [`VS2019=1|0`](#vs2019) - [Variables](#variables) - [`CTEST_OUTPUT_ON_FAILURE=1|0`](#ctest_output_on_failure) - [`QUIET=1|0`](#quiet) @@ -382,10 +388,13 @@ Configuration variables: - [`CMAKE_GENERATOR=''|'...'`](#cmake_generator) [specifies which generator to use](https://cmake.org/cmake/help/latest/envvar/CMAKE_GENERATOR.html#envvar:CMAKE_GENERATOR). -- [`CC=cc|gcc|clang|...`](#cc) +- [`CMAKE_TOOLCHAIN_FILE=''|'...'`](#cmake_toolchain_file) + [specifies toolchain file to use](https://cmake.org/cmake/help/latest/variable/CMAKE_TOOLCHAIN_FILE.html). + +- [`CC=cc|gcc|clang|emcc|...`](#cc) [specifies which C compiler to use](https://cmake.org/cmake/help/latest/envvar/CC.html). -- [`CXX=c++|g++|clang++|...`](#cxx) +- [`CXX=c++|g++|clang++|emcc|...`](#cxx) [specifies which C++ compiler to use](https://cmake.org/cmake/help/latest/envvar/CXX.html). - [`CLEAN=0|1`](#clean) specifies whether the build directory @@ -528,31 +537,45 @@ and [CI script](https://github.com/cppsm/cppsm-cli/blob/master/travis-ci) is provided to build and test both `Debug` and `Release` builds on various OS (Linux, OS X, Windows) and compiler configurations ([Clang](https://clang.llvm.org/), [GCC](https://gcc.gnu.org/), -[Visual C++](https://docs.microsoft.com/en-us/cpp/)). Just add your project to -Travis CI. +[Visual C++](https://docs.microsoft.com/en-us/cpp/), +[Emscripten](https://emscripten.org/)). Just add your project to Travis CI. - Linux - [Clang](https://clang.llvm.org/) (7) - [GCC](https://gcc.gnu.org/) (9) + - [Emscripten](https://emscripten.org/) (2) - OS X - Apple [Clang](https://clang.llvm.org/) (12) - [GCC](https://gcc.gnu.org/) (10) + - [Emscripten](https://emscripten.org/) (2) - Windows - [MinGW](http://www.mingw.org/) [GCC](https://gcc.gnu.org/) (8) - [Visual C++](https://docs.microsoft.com/en-us/cpp/) (2017, 2019) Configuration variables: +- [`CLANG=1|0`](#clang) specifies whether to build with + [Clang](https://clang.llvm.org/). Set `CLANG=0` explicitly to skip building + with [Clang](https://clang.llvm.org/). + - [`CODECOV=0|1`](#codecov) specifies whether a code coverage test is executed and results are pushed to [Codecov](https://codecov.io/). Set `CODECOV=1` explicitly to enable code coverage. +- [`EMSCRIPTEN=0|1`](#emscripten) specifies whether to + also build with [Emscripten](https://emscripten.org/). Set `EMSCRIPTEN=1` + explicitly to build with [Emscripten](https://emscripten.org/). + - [`FORMAT_CHECK=1|0`](#format_check) specifies whether to check that source files are formatted as with [`cppsm format`](#cppsm-format). Set `FORMAT_CHECK=0` explicitly to disable the format check. +- [`GCC=1|0`](#gcc) specifies whether to build with + [GCC](https://gcc.gnu.org/). Set `GCC=0` explicitly to skip building with + [GCC](https://gcc.gnu.org/). + - [`INSTALL_WAIT=0|1`](#install_wait) specifies whether installation of additional packages is performed concurrently with builds when possible. Set `INSTALL_WAIT=1` explicitly to wait for installations to @@ -563,6 +586,16 @@ Configuration variables: and, if something is upgraded, tests are rerun. Set `UPGRADE_CHECK=0` explicitly to skip the upgrade and conditional rerun of tests. +- [`VS2017=1|0`](#vs2017) specifies whether to build with + [Visual C++](https://docs.microsoft.com/en-us/cpp/) 2017. Set `VS2017=0` + explicitly to skip building with + [Visual C++](https://docs.microsoft.com/en-us/cpp/) 2017. + +- [`VS2019=1|0`](#vs2019) specifies whether to build with + [Visual C++](https://docs.microsoft.com/en-us/cpp/) 2019. Set `VS2019=0` + explicitly to skip building with + [Visual C++](https://docs.microsoft.com/en-us/cpp/) 2019. + ## [≡](#contents) [Variables](#variables) Several environment variables can be set to change the default behavior of one