File: README.rst

package info (click to toggle)
llvm-toolchain-18 1%3A18.1.8-18
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,908,340 kB
  • sloc: cpp: 6,667,937; ansic: 1,440,452; asm: 883,619; python: 230,549; objc: 76,880; f90: 74,238; lisp: 35,989; pascal: 16,571; sh: 10,229; perl: 7,459; ml: 5,047; awk: 3,523; makefile: 2,987; javascript: 2,149; xml: 892; fortran: 649; cs: 573
file content (80 lines) | stat: -rw-r--r-- 2,258 bytes parent folder | download | duplicates (11)
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
LLVM Toolchain Integration Test Suite
#####################################

An agglomeration of integration tests for the `LLVM Toolchain <https://llvm.org/>`_.
Unlike the various existing llvm testing suites, this is meant to be used in an installed
environment to detect packaging issues.

This is an initiative started by Debian/Ubuntu and Fedora maintainers to agregate the testing effort.
Hopefully, this project will be also a forcing function to bring more consistency in the LLVM
toolchain packaging.

Requirements
------------

The `lit <https://pypi.org/project/lit/>`_ tool is used to run the tests and
`cmake <https://cmake.org/>`_ is used for the configuration step.

Usage
-----

From source directory:

.. code-block:: sh

    > mkdir _build && cd _build
    > cmake ..
    > make check

Sensible configuration variables
--------------------------------

- ``LIT``: path to the lit program

- ``CLANG_BINARY``: path to the clang binary to check
- ``CLANGXX_BINARY``: path to the clang++ binary to check
- ``CLANG_TIDY_BINARY``: path to the clang tidy binary to check
- ``LLD_BINARY``: path to the lld binary to check
- ``LLDB_BINARY``: path to the lldb binary to check

- ``ENABLE_COMPILER_RT``: ON (the default) if we assume compiler-rt is available
- ``ENABLE_LIBCXX``: ON (the default) if we assume libc++ is available
- ``ENABLE_STATIC_LIBCXX``: ON (the default) if we assume libc++.a is available
- ``ENABLE_LIBUNWIND``: ON (the default) if we assume libunwind is available
- ``ENABLE_HWASAN``: Run hwasan tests. Autodetected based on the host system.
- ``ENABLE_LIBOMP``: Run libomp tests. Autodetected based on the system. It can
    be manually forced via `-DENABLE_LIBOMP=<ON|OFF>` at cmake configure time

Writing new tests
-----------------

Just drop a new file under ``tests/``, using the lit format. Please use the following substitutions and requirements:

Lit substitutions
+++++++++++++++++

    - ``%clang``
    - ``%clangxx``
    - ``%clang-tidy``
    - ``%lldb``
    - ``%lld``
    - ``%scan-build``
    - ``%scan-view``
    - ``%scan-build-py``

requirements
++++++++++++

    - clang
    - clangxx
    - clang-tidy
    - lldb
    - lld
    - scanbuild
    - scanbuild-py
    - scanview

License
-------

See LICENSE.txt