Skip to content

Latest commit

 

History

History
164 lines (121 loc) · 5.82 KB

BUILD.md

File metadata and controls

164 lines (121 loc) · 5.82 KB
Raw

Build Requirements

Daffodil's build requirements include:

  • Java 8 or higher
  • sbt 0.13.8 or higher
  • C compiler C99 or higher
  • Mini-XML Version 3.0 or higher

You will need the Java Software Development Kit (Java) and the Scala Build Tool (sbt) to build Daffodil, run all tests, create packages, and more. You can install the latest Java LTS version and the latest sbt version following their websites' instructions or install them using your operating system's package manager.

Since Daffodil now has a C backend as well as a Scala backend, you will need a C compiler supporting the C99 standard or later and the Mini-XML library. You can install either gcc or clang using your operating system's package manager. If you can't install the Mini-XML library using your operating system's package manager, you'll have to build it from source. We'll tell you how to do that on Windows but the commands should work on other operating systems too.

You can set your environment variables CC and AR to the correct commands (or set them to true to disable C compilation altogether) if you don't want sbt compile to call your C compiler with cc and ar as the default commands.

Fedora/CentOS/RHEL

When building on CentOS or RHEL, the EPEL repository must be enabled by following its website's instructions. This is necessary to install the libmxml-devel package.

You can use the dnf package manager to install most of the tools used to develop Daffodil:

sudo dnf install clang gcc git iwyu java-11-openjdk-devel llvm make mxml-devel pkgconf

If you want to use clang instead of gcc, you'll have to set your environment variables CC and AR to the clang binaries' names:

export CC=clang AR=llvm-ar

However, Fedora has no sbt package in its own repositories. You'll have to install the latest sbt version following its website's instructions.

Now you can build Daffodil from source and the sbt and daffodil commands you type will be able to call the C compiler.

Ubuntu

You can use the apt package manager to install all of the tools used to develop Daffodil:

sudo apt install build-essential clang clang-format default-jdk git iwyu libcriterion-dev libmxml-dev
# If "iwyu -print-resource-dir" prints /usr/lib/clang/13.0.1 and it doesn't exist:
sudo apt install libclang-common-13-dev

If you want to use clang instead of gcc, you'll have to set your environment variables CC and AR to the clang binaries' names:

export CC=clang AR=llvm-ar-14 # or whatever llvm-ar-* version you have

However, Ubuntu has no sbt package in its own repositories. You'll have to install the latest sbt version following its website's instructions.

Now you can build Daffodil from source and the sbt and daffodil commands you type will be able to call the C compiler.

Windows 10

Install the latest Java LTS version and the latest sbt version following their websites' instructions.

Install MSYS2 following its website's instructions and open a new "MSYS2 MSYS" window. We'll need its collection of free programs and libraries.

You can use the pacman package manager to install most of the tools used to develop Daffodil:

pacman -S clang diffutils gcc git make pkgconf

If you want to use clang instead of gcc, you'll have to set your environment variables CC and AR to the clang binaries' names:

export CC=clang AR=llvm-ar

However, MSYS2 has no libmxml-devel package so you'll have to build the Mini-XML library from source:

git clone -b v3.3 https://github.com/michaelrsweet/mxml.git
# some daffodil tests fail if you build mxml with clang
unset CC AR
cd mxml
./configure --prefix=/usr --disable-shared --disable-threads
make
make install

Define an environment variable with the name MSYS2_PATH_TYPE and the value inherit using Windows' control panel for editing environment variables.

Now when you open a new "MSYS2 MSYS" window from the Start Menu to build Daffodil from source, the sbt and daffodil commands you type will be able to call the C compiler.

macOS

Install the Xcode Command Line Tools:

xcode-select --install

You can use the Homebrew package manager to install most of the tools used to develop Daffodil:

brew install clang-format
brew install criterion
brew install git
brew install llvm # needed by iwyu
brew install include-what-you-use
brew install openjdk
brew install sbt

Install libmxml v3.3.1 from source:

git clone https://github.com/michaelrsweet/mxml
cd mxml
git checkout v3.3.1
./configure
sudo make install

Now you can build Daffodil from source and the sbt and daffodil commands you type will be able to call the C compiler.