diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 39 |
1 files changed, 20 insertions, 19 deletions
@@ -1,6 +1,6 @@ # Include What You Use # -[](https://travis-ci.org/include-what-you-use/include-what-you-use) +[](https://github.com/include-what-you-use/include-what-you-use/actions/workflows/ci.yml) For more in-depth documentation, see [docs](docs). @@ -20,27 +20,28 @@ While we work to get IWYU quality up, we will be stinting new features, and will Include-what-you-use makes heavy use of Clang internals, and will occasionally break when Clang is updated. Usually such discrepancies are detected by build bot and fixed promptly. -**The IWYU master branch follows Clang trunk**. +**The IWYU master branch follows Clang main branch**. We also have convenience tags and branches for released versions of Clang (called `clang_<version>`, e.g. `clang_5.0`). To build against a Clang release, check out the corresponding branch in IWYU before configuring the build. More details in the instructions below. We assume you already have compiled LLVM and Clang libraries on your system, either via packages for your platform or built from source. You can use this mapping table to combine Clang and IWYU versions correctly: -| Clang | IWYU version | IWYU branch | -|--------|--------------|----------------| -| 3.6 | 0.4 | `clang_3.6` | -| 3.7 | 0.5 | `clang_3.7` | -| 3.8 | 0.6 | `clang_3.8` | -| 3.9 | 0.7 | `clang_3.9` | -| 4.0 | 0.8 | `clang_4.0-r2` | -| 5.0 | 0.9 | `clang_5.0` | -| 6 | 0.10 | `clang_6.0` | -| 7 | 0.11 | `clang_7.0` | -| 8 | 0.12 | `clang_8.0` | -| 9 | 0.13 | `clang_9.0` | -| 10 | 0.14 | `clang_10` | -| ... | ... | ... | -| trunk | master | `master` | +| Clang | IWYU version | IWYU branch | +|-------|--------------|----------------| +| 3.6 | 0.4 | `clang_3.6` | +| 3.7 | 0.5 | `clang_3.7` | +| 3.8 | 0.6 | `clang_3.8` | +| 3.9 | 0.7 | `clang_3.9` | +| 4.0 | 0.8 | `clang_4.0-r2` | +| 5.0 | 0.9 | `clang_5.0` | +| 6 | 0.10 | `clang_6.0` | +| 7 | 0.11 | `clang_7.0` | +| 8 | 0.12 | `clang_8.0` | +| 9 | 0.13 | `clang_9.0` | +| 10 | 0.14 | `clang_10` | +| 11 | 0.15 | `clang_11` | +| ... | ... | ... | +| main | | `master` | > NOTE: If you use the Debian/Ubuntu packaging available from <https://apt.llvm.org>, you'll need the following packages installed: > @@ -58,7 +59,7 @@ To set up an environment for building: iwyu$ git clone https://github.com/include-what-you-use/include-what-you-use.git -* Presumably, you'll be building IWYU with a released version of LLVM and Clang, so check out the corresponding branch. For example, if you have Clang 6.0 installed, use the `clang_6.0` branch. IWYU `master` tracks LLVM & Clang trunk: +* Presumably, you'll be building IWYU with a released version of LLVM and Clang, so check out the corresponding branch. For example, if you have Clang 6.0 installed, use the `clang_6.0` branch. IWYU `master` tracks LLVM & Clang `main`: iwyu$ cd include-what-you-use iwyu/include-what-you-use$ git checkout clang_6.0 @@ -79,7 +80,7 @@ To set up an environment for building: or, if you have a local LLVM and Clang build tree, you can specify that as `CMAKE_PREFIX_PATH` for IWYU 0.11 and later: - iwyu/build$ cmake -G "Unix Makefiles" -DCMAKE_PREFIX_PATH=/llvm-trunk/build ../include-what-you-use + iwyu/build$ cmake -G "Unix Makefiles" -DCMAKE_PREFIX_PATH=~/llvm-project/build ../include-what-you-use * Once CMake has generated a build system, you can invoke it directly from `build`, e.g. |