Mirrors/cppbestpractices
1
0
Fork 0
mirror of https://github.com/cpp-best-practices/cppbestpractices.git synced 2025-12-17 03:04:36 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

Addition of package management section

Browse Source
This commit is contained in:
Jason Turner
2018-07-18 16:24:18 -06:00
committed by GitHub
parent c4fb1cf8f8
commit aa2f8ce9ca
1 changed files with 16 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
02-Use_the_Tools_Available.md
View File

@@ -21,8 +21,7 @@ Use an industry standard widely accepted build tool. This prevents you from rein
* Consider: https://github.com/toeb/cmakepp for enhanced usability * Consider: https://github.com/toeb/cmakepp for enhanced usability
* Utilize: https://cmake.org/cmake/help/v3.6/command/target_compile_features.html for C++ standard flags * Utilize: https://cmake.org/cmake/help/v3.6/command/target_compile_features.html for C++ standard flags
* Consider: https://github.com/cheshirekow/cmake_format for automatic formatting of your CMakeLists.txt * Consider: https://github.com/cheshirekow/cmake_format for automatic formatting of your CMakeLists.txt
* [Conan](https://www.conan.io/) - a crossplatform dependency manager for C++ * See the [Further Reading](10-Further_Reading.md) section for CMake specific best practices
* [C++ Archive Network (CPPAN)](https://cppan.org/) - a crossplatform dependency manager for C++
* [Waf](https://waf.io/) * [Waf](https://waf.io/)
* [FASTBuild](http://www.fastbuild.org/) * [FASTBuild](http://www.fastbuild.org/)
* [Ninja](https://ninja-build.org/) - can greatly improve the incremental build time of your larger projects. Can be used as a target for CMake. * [Ninja](https://ninja-build.org/) - can greatly improve the incremental build time of your larger projects. Can be used as a target for CMake.
@@ -32,10 +31,20 @@ Use an industry standard widely accepted build tool. This prevents you from rein
* [Qt Build Suite](http://doc.qt.io/qbs/) - Crossplatform build tool From Qt. * [Qt Build Suite](http://doc.qt.io/qbs/) - Crossplatform build tool From Qt.
* [meson](http://mesonbuild.com/index.html) - Open source build system meant to be both extremely fast, and, even more importantly, as user friendly as possible. * [meson](http://mesonbuild.com/index.html) - Open source build system meant to be both extremely fast, and, even more importantly, as user friendly as possible.
* [premake](https://premake.github.io/) * [premake](https://premake.github.io/)
* [hunter](https://github.com/ruslo/hunter) - CMake driven cross-platform package manager for C/C++
Remember, it's not just a build tool, it's also a programming language. Try to maintain good clean build scripts and follow the recommended practices for the tool you are using. Remember, it's not just a build tool, it's also a programming language. Try to maintain good clean build scripts and follow the recommended practices for the tool you are using.
## Package Manager
Package management is an important topic in C++, with currently no clear winner. Consider using a package manager to help you keep track of the dependencies for your project and make it easier for new people to get started with the project.
* [Conan](https://www.conan.io/) - a crossplatform dependency manager for C++
* [hunter](https://github.com/ruslo/hunter) - CMake driven cross-platform package manager for C/C++
* [C++ Archive Network (CPPAN)](https://cppan.org/) - a crossplatform dependency manager for C++
* [qpm](https://www.qpm.io/) - Package manager for Qt
## Continuous Integration ## Continuous Integration
Once you have picked your build tool, set up a continuous integration environment. Once you have picked your build tool, set up a continuous integration environment.
@@ -248,6 +257,7 @@ A coverage analysis tool shall be run when tests are executed to make sure the e
* [kcov](http://simonkagstrom.github.io/kcov/index.html) * [kcov](http://simonkagstrom.github.io/kcov/index.html)
* integrates with codecov and coveralls * integrates with codecov and coveralls
* performs code coverage reporting without needing special compiler flags, just by instrumenting debug symbols. * performs code coverage reporting without needing special compiler flags, just by instrumenting debug symbols.
* [OpenCppCoverage](https://github.com/OpenCppCoverage/OpenCppCoverage) - open source coverage reporting tool for Windows.
### Valgrind ### Valgrind
@@ -267,6 +277,8 @@ These tools provide many of the same features as Valgrind, but built into the co
* ThreadSanitizer * ThreadSanitizer
* UndefinedBehaviorSanitizer * UndefinedBehaviorSanitizer
Be aware of the sanitizer options available, including runtime options. https://kristerw.blogspot.com/2018/06/useful-gcc-address-sanitizer-checks-not.html
### Fuzzy Analyzers ### Fuzzy Analyzers
If your project accepts user defined input, considering running a fuzzy input tester. If your project accepts user defined input, considering running a fuzzy input tester.