Contributing to LLVM

PrerequisitesPermalink

First, read the official documentation.

SetupPermalink

Forking and cloning the LLVM repositoryPermalink

Head over to the LLVM repository page and fork it.

Once GitHub has finished forking the repo, use git to clone your fork.

$ git clone git@github.com:<your-github-username>/llvm-project.git
$ cd llvm-project
$ mkdir build
$ cd build

BuildingPermalink

See How to Build M68k LLVM.

Running the M68k testsPermalink

Running tests using CMakePermalink

Running all the testsPermalink

Invoke CMake to run all the tests:

cmake --build . --target check-all

Running specific sets of testsPermalink

It takes significantly longer to run all the tests than it does to only run targeted M68k-related tests. In order to iterate more quickly, you can run only the M68k tests, rather than all the tests.

cmake --build . --target check-llvm-codegen-m68k

There are several useful test-related targets:

Additionally, the llvm-test-depends target builds all the dependencies required to run LLVM tests, but does not run the tests.

Running tests using llvm-litPermalink

Invoke CMake to build the testing dependencies:

cmake --build . --target llvm-test-depends

Invoke llvm-lit to run the M68k tests:

bin/llvm-lit \
    test/CodeGen/M68k \
    test/DebugInfo/M68k \
    test/MC/Disassembler/M68k \
    test/MC/M68k

llvm-lit is the LLVM Integrated Tester utility.

We specify the directories containing M68k-related tests. The directories are relative to the path specified by config.llvm_src_root in build/test/lit.site.cfg.py.

You should see output something like:

-- Testing: 168 tests, 8 workers --
PASS: LLVM :: CodeGen/M68k/Arith/lshr.ll (1 of 168)
PASS: LLVM :: CodeGen/M68k/Alloc/dyn_alloca_aligned.ll (2 of 168)
(more tests)
PASS: LLVM :: MC/M68k/pc-rel.s (168 of 168)

Testing Time: 7.61s

Total Discovered Tests: 168
  Passed: 168 (100.00%)

Making changesPermalink

TO DO

Getting your changes into LLVMPermalink

See the LLVM code review process documentation.