README.md

Dotnet JIT code gen utilities - jitutils

This repo holds a collection of utilities used by RyuJIT developers to automate tasks when working on CoreCLR.

Summary

Current tools include:

1. Assembly diffs: jit-diff, jit-dasm, jit-dasm-pmi, jit-analyze, jit-tp-analyze.
2. CI jobs information: cijobs.
3. JIT source code formatting: jit-format.
4. General tools: pmi
5. Experimental tools: performance-explorer
6. BenchmarkDotNet Analysis

Getting started

1. Clone the jitutils repo:

    git clone https://github.com/dotnet/jitutils

2. Install a recent .NET Core SDK (including the dotnet command-line interface, or CLI) from here.

3. Build the tools:

    cd jitutils
    bootstrap.cmd

(on non-Windows, run bootstrap.sh. NOTE: On Mac, you need to first use ulimit -n 2048 or the dotnet restore part of the build will fail.)

4. Optionally, add the built tools directory to your path, e.g.:

    set PATH=%PATH%;<root>\jitutils\bin