blob: 76a34f919e16cd7dc995df97da629df4b3d2efe1 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
|
cmake-common
============
[](https://github.com/egor-tensin/cmake-common/actions/workflows/basic.yml)
[](https://github.com/egor-tensin/cmake-common/actions/workflows/boost_toolsets.yml)
[](https://github.com/egor-tensin/cmake-common/actions/workflows/example_toolsets.yml)
Utilities to help develop C++/CMake projects.
Installation
------------
* Via PyPI:
pip install cmake-common
* As a submodule:
git submodule add https://github.com/egor-tensin/cmake-common.git
All the scripts provided by the PyPI package are thin wrappers around the
`project` package modules:
| Script | Module
| -------------- | ------
| boost-download | `python3 -m project.boost.download`
| boost-build | `python3 -m project.boost.build`
| cmake-build | `python3 -m project.cmake.build`
| ci-boost | `python3 -m project.ci.boost`
| ci-cmake | `python3 -m project.ci.cmake`
Toolsets
--------
Supported platform/build system/compiler combinations include, but are not
limited to:
| Platform | Build system | Compiler |
| -------- | -------------- | ----------- |
| Linux | make | Clang |
| | | GCC |
| | | MinGW-w64 |
| Windows | make \[1\] | Clang \[2\] |
| | | MinGW-w64 |
| | msbuild | MSVC |
| Cygwin | make | Clang |
| | | GCC |
| | | MinGW-w64 |
1. Both GNU make and MinGW mingw32-make.
2. clang-cl is supported by Boost 1.69.0 or higher only.
All of those are verified continuously by the [Boost (toolsets)] and [Examples
(toolsets)] workflows.
For a complete list of possible `--toolset` parameter values, pass the
`--help-toolsets` flag to either `boost-build` or `cmake-build`.
[Boost (toolsets)]: https://github.com/egor-tensin/cmake-common/actions/workflows/boost_toolsets.yml
[Examples (toolsets)]: https://github.com/egor-tensin/cmake-common/actions/workflows/example_toolsets.yml
Usage
-----
### Boost
Download & build the Boost libraries in a cross-platform way.
$ boost-download 1.72.0
...
$ boost-build -- boost_1_72_0/ --with-filesystem --with-program_options
...
Pass the `--help` flag to view detailed usage information.
### CMake project
Build (and optionally, install) a CMake project.
$ cmake-build --configuration Release --install path/to/somewhere --boost path/to/boost -- examples/simple build/
...
$ ./path/to/somewhere/bin/foo
foo
Pass the `--help` flag to view detailed usage information.
### common.cmake
Use in a project by putting
include(path/to/common.cmake)
in CMakeLists.txt.
This file aids in quick-and-dirty development by
* linking everything (including the runtime) statically by default,
* setting some useful compilation options (enables warnings, defines useful
Windows-specific macros, strips debug symbols in release builds, etc.).
Everything is optional (use the `CC_*` CMake options to opt out).
### CI
Utility scripts `ci-boost` and `ci-cmake` allow building Boost and CMake
projects on multiple CI systems.
They work by calling the generic scripts from above, auto-filling some
parameters from environment variables.
| | Travis | AppVeyor | GitHub Actions
| ----------------- | ------------------------------------ | ------------------------------------------ | --------------
| `--toolset` | `$TOOLSET` | `%TOOLSET%` | `$TOOLSET`
| `--platform` | `$PLATFORM` | `%PLATFORM%` | `$PLATFORM`
| `--configuration` | `$CONFIGURATION` | `%CONFIGURATION%` | `$CONFIGURATION`
| Boost version | `$BOOST_VERSION` | `%BOOST_VERSION%` | `$BOOST_VERSION`
| Boost path | `$TRAVIS_BUILD_DIR/../build/boost` | `%APPVEYOR_BUILD_FOLDER%\..\build\boost` | `$GITHUB_WORKSPACE/../build/boost`
| Build path | `$TRAVIS_BUILD_DIR/../build/cmake` | `%APPVEYOR_BUILD_FOLDER%\..\build\cmake` | `$GITHUB_WORKSPACE/../build/cmake`
| Install path | `$TRAVIS_BUILD_DIR/../build/install` | `%APPVEYOR_BUILD_FOLDER%\..\build\install` | `$GITHUB_WORKSPACE/../build/install`
For an example of how to integrate `ci-boost` and `ci-cmake` into a CI
workflow, see [docs/ci.md](docs/ci.md).
Tools
-----
* [project-clang-format.py] — `clang-format` all C/C++ files in the
project.
* [ctest-driver.py] — wrap an executable for testing with CTest;
cross-platform `grep`.
[project-clang-format.py]: docs/project-clang-format.md
[ctest-driver.py]: docs/ctest-driver.md
Examples
--------
I use this in all of my C++/CMake projects, e.g. [aes-tools] and [math-server].
[aes-tools]: https://github.com/egor-tensin/aes-tools
[math-server]: https://github.com/egor-tensin/math-server
Development
-----------
Make a git tag:
git tag "v$( python -m setuptools_scm --strip-dev )"
You can then review that the tag is fine and push w/ `git push --tags`.
License
-------
Distributed under the MIT License.
See [LICENSE.txt] for details.
[LICENSE.txt]: LICENSE.txt
|
