Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/polysquare/iwyu-target-cmake

CMake integration for include-what-you-use
https://github.com/polysquare/iwyu-target-cmake

Last synced: about 2 months ago
JSON representation

CMake integration for include-what-you-use

Host: GitHub
URL: https://github.com/polysquare/iwyu-target-cmake
Owner: polysquare
License: mit
Created: 2014-09-28T14:39:53.000Z (almost 10 years ago)
Default Branch: master
Last Pushed: 2016-05-30T14:17:45.000Z (about 8 years ago)
Last Synced: 2024-03-26T20:59:12.432Z (3 months ago)
Language: CMake
Size: 52.7 KB
Stars: 10
Watchers: 5
Forks: 4
Open Issues: 0
Metadata Files:
- Readme: README.md

Lists

awesome-cmake - iwyu-target-cmake - CMake integration for include-what-you-use. [```[MIT]```][MIT] (Utility Scripts)

README

        # Include-What-You-Use CMake Targets #

CMake macro to add per-source level checks on individual targets for

include-what-you-use violations

## Status ##

| Travis CI (Ubuntu) | AppVeyor (Windows) | Coverage | Biicode | Licence |

|--------------------|--------------------|----------|---------|---------|

|[![Travis](https://img.shields.io/travis/polysquare/iwyu-target-cmake.svg)](http://travis-ci.org/polysquare/iwyu-target-cmake)|[![AppVeyor](https://img.shields.io/appveyor/ci/smspillaz/include-what-you-use-target-cmake.svg)](https://ci.appveyor.com/project/smspillaz/include-what-you-use-target-cmake)|[![Coveralls](https://img.shields.io/coveralls/polysquare/iwyu-target-cmake.svg)](http://coveralls.io/polysquare/iwyu-target-cmake)|[![Biicode](https://webapi.biicode.com/v1/badges/smspillaz/smspillaz/iwyu-target-cmake/master)](https://www.biicode.com/smspillaz/iwyu-target-cmake)|[![License](https://img.shields.io/github/license/polysquare/iwyu-target-cmake.svg)](http://github.com/polysquare/iwyu-target-cmake)|

## Description ##

`iwyu-target-cmake` can be used to scan individual source files for

include-what-you-use violations. The check is added to target and automatically

run over all of it its source files.

## Usage ##

`include-what-you-use-target-cmake` works by scanning source files for `#include`

statements and then checks the passed include directories for files matching the

name of files specified in the `#include` statements.

### Checking a target ###

#### `iwyu_target_sources` ####

Examine the sources attached to TARGET for include-what-you-use

violations. The compiler flags as indicated in the arguments

are passed to include-what-you-use to determine whether or not

included files are not necessary.

* `TARGET`: Target to check

* [Optional] `CHECK_GENERATED`: Also check generated files, off by default.

* [Optional] `WARN_ONLY`: Don't abort the build on violations, just warn.

* [Optional] `FORCE_LANGUAGE`: Treat source files for this target as either

                               C or CXX.

* [Optional] `EXTERNAL_INCLUDE_DIRS`: System-level include directories

                                      (will not be transitively examined).

* [Optional] `INTERNAL_INCLUDE_DIRS`: Include directories in this project

                                      (will be transitively examined).

* [Optional] `DEFINES`: Definitions to set when preprocessing.

* [Optional] `CPP_IDENTIFIERS`: Identifiers which indicate that a header

                                file scanned is always C++.

* [Optional] `DEPENDS`: Targets to run or source files to generate before

                        checking the sources for violations.