Archive-Team
/
zfs
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 103 Wiki Activity

Updated Building ZFS (markdown)

Brian Behlendorf 2016-05-10 19:10:10 -07:00
parent 1f8aa849b0
commit 5d60e13dea
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
Building-ZFS.md

@ -1,14 +1,14 @@
### GitHub Repositories ### GitHub Repositories
The official source for ZFS on Linux is maintained at GitHub by the [zfsonlinux organization][zol-org]. The project consists of two primary git repositories named [spl][spl-repo] and [zfs][zfs-repo], both are required to build ZFS on Linux. The official source for ZFS on Linux is maintained at GitHub by the [zfsonlinux][zol-org] organization. The project consists of two primary git repositories named [spl][spl-repo] and [zfs][zfs-repo], both are required to build ZFS on Linux.
* **SPL**: The SPL is thin shim layer which is responsible for implementing the fundamental interfaces required by OpenZFS. It's this layer which allows OpenZFS to be used across multiple platforms. * **SPL**: The SPL is thin shim layer which is responsible for implementing the fundamental interfaces required by OpenZFS. It's this layer which allows OpenZFS to be used across multiple platforms.
* **ZFS**: The ZFS repository contains a copy of the upstream OpenZFS code which has been adapted and extended for Linux. However, the vast majority of the core OpenZFS code is self contained and can be used without modification. * **ZFS**: The ZFS repository contains a copy of the upstream OpenZFS code which has been adapted and extended for Linux. The vast majority of the core OpenZFS code is self-contained and can be used without modification.
### Installing Dependencies ### Installing Dependencies
The first thing you'll need to do is prepare your environment by installing a full development tool chain. In addition, development headers for both the kernel and the following libraries must be available: zlib, libattr, libuuid, libblkid, selinux, libudev (optional). Finally, if you wish to run the ZFS Test Suite make sure ksh is installed. The first thing you'll need to do is prepare your environment by installing a full development tool chain. In addition, development headers for both the kernel and the following libraries must be available: **zlib, libattr, libuuid, libblkid, selinux, libudev (optional)**. Finally, if you wish to run the ZFS Test Suite **ksh** must be installed.
For Debian and Ubuntu: For Debian and Ubuntu:
@ -28,19 +28,19 @@ sudo yum install parted lsscsi ksh
### Build Options ### Build Options
There are two methods for building ZFS on Linux depending on your requirements. There are two options for building ZFS on Linux, the correct one largely depends on your requirements.
* **Packages**: Often it can be useful to build custom packages from git which can be installed on a system. This is the best way to perform integration testing with systemd, dracut, and udev. The downside to using packages it is greatly increases the time required to build, install, and test a change. * **Packages**: Often it can be useful to build custom packages from git which can be installed on a system. This is the best way to perform integration testing with systemd, dracut, and udev. The downside to using packages it is greatly increases the time required to build, install, and test a change.
* **In-tree**: Alternately, development can be done entirely in the spl and zfs source trees. This can reduce development time by allowing a developer to rapidly iterate on a patch. When working in-tree developers can leverage incremental builds, load/unload kernel modules, run utilities, and verify all their changes with the ZFS test suite. * **In-tree**: Development can be done entirely in the SPL and ZFS source trees. This speeds up development by allowing developers to rapidly iterate on a patch. When working in-tree developers can leverage incremental builds, load/unload kernel modules, execute utilities, and verify all their changes with the ZFS Test Suite.
The remainder of this page focuses on **in-tree** development which is the recommended method for the majority of changes. See the [[custom-packages]] page for additional information of building packages. The remainder of this page focuses on the **in-tree** option which is the recommended method of development for the majority of changes. See the [[custom-packages]] page for additional information on building custom packages.
### Developing In-Tree ### Developing In-Tree
#### Clone from GitHub #### Clone from GitHub
Start by cloning the spl and zfs repositories from GitHub. The repositories have a **master** branch for development and a series of **\*-release** branches for tagged production releases. After checking out the repository your clone will default to the master branch. Tagged releases may be built by checking out spl/zfs-x.y.z tags with matching version numbers or matching release branches. Avoid using mismatched versions, this can result in a build failures due to interface changes. Start by cloning the SPL and ZFS repositories from GitHub. The repositories have a **master** branch for development and a series of **\*-release** branches for tagged releases. After checking out the repository your clone will default to the master branch. Tagged releases may be built by checking out spl/zfs-x.y.z tags with matching version numbers or matching release branches. Avoid using mismatched versions, this can result build failures due to interface changes.
``` ```
git clone https://github.com/zfsonlinux/spl git clone https://github.com/zfsonlinux/spl
@ -51,7 +51,7 @@ git clone https://github.com/zfsonlinux/zfs
For developers working on a change always create a new topic branch based off of master. This will make it easy to open a pull request with your change latter. The master branch is kept stable with extensive [regression testing][buildbot] of every pull request before and after it's merged. Every effort is made to catch defects as early as possible and to keep them out of the tree. Developers should be comfortable frequently rebasing their work against the latest master branch. For developers working on a change always create a new topic branch based off of master. This will make it easy to open a pull request with your change latter. The master branch is kept stable with extensive [regression testing][buildbot] of every pull request before and after it's merged. Every effort is made to catch defects as early as possible and to keep them out of the tree. Developers should be comfortable frequently rebasing their work against the latest master branch.
In this example, we'll be using the master branch and a default in-tree build. As mentioned above ZFS layers on top of the spl so its necessary to build this dependency first. Start by checking out the desired branch then build the spl source in the tradition autotools fashion. In this example we'll use the master branch and walk through a stock **in-tree** build. As mentioned above ZFS layers on top of the SPL so its necessary to build this repository first. Start by checking out the desired branch then build the SPL source in the tradition autotools fashion.
``` ```
cd spl cd spl
@ -78,9 +78,9 @@ make -s -j$(nproc)
#### Run the ZFS Test Suite #### Run the ZFS Test Suite
There are a few helper scripts provided in the top-level scripts directory designed to aid using ZFS in-tree. There are a few helper scripts provided in the top-level scripts directory designed to aid developers working with in-tree builds.
* **zfs-helper.sh:** Certain functionality (i.e. /dev/zvol/) depends on the ZFS provided helper scripts being installed on your system. This script can be used to create symlinks on your system from the installation location to your in-tree version of the helper. These links must be in place to successful run the ZFS Test Suite. The **-i** and **-r** options can be used to install and remove the symlinks. * **zfs-helper.sh:** Certain functionality (i.e. /dev/zvol/) depends on the ZFS provided udev helper scripts being installed on the system. This script can be used to create symlinks on the system from the installation location to the in-tree helper. These links must be in place to successfully run the ZFS Test Suite. The **-i** and **-r** options can be used to install and remove the symlinks.
``` ```
sudo ./scripts/zfs-helpers.sh -i sudo ./scripts/zfs-helpers.sh -i
@ -92,7 +92,7 @@ sudo ./scripts/zfs-helpers.sh -i
sudo ./scripts/zfs.sh sudo ./scripts/zfs.sh
``` ```
* **zfs-tests.sh:** A wrapper which can be used to launch the ZFS Test Suite. Three loopback devices will be created on top of sparse files located in /var/tmp/ and used for the regression test. Detailed directions for the ZFS Test Suite can be found in the [README][zts-readme] located in the top-level tests directory. * **zfs-tests.sh:** A wrapper which can be used to launch the ZFS Test Suite. Three loopback devices are created on top of sparse files located in `/var/tmp/` and used for the regression test. Detailed directions for the ZFS Test Suite can be found in the [README][zts-readme] located in the top-level tests directory.
``` ```
./scripts/zfs-tests.sh -vx ./scripts/zfs-tests.sh -vx