OpenZFS on Linux and FreeBSD
Go to file
Matthew Ahrens 1149b62d20 Update README: run autogen first
Reviewed-by: Giuseppe Di Natale <dinatale2@llnl.gov>
Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Reviewed-by: George Melikov <mail@gmelikov.ru>
Signed-off-by: Matthew Ahrens <mahrens@delphix.com>
Closes #704
2018-05-07 10:12:25 -07:00
cmd Make file headers conform to ZFS style standard 2017-10-09 14:27:27 -07:00
config Fix undefined RPM macros 2018-05-02 15:34:20 -07:00
include Linux compat 4.16: SECTOR_SIZE 2018-04-09 17:20:06 -07:00
lib glibc 2.25 compat: remove assert(X=Y) 2017-04-03 13:33:48 -07:00
man Update spl module parameters man5 with missing parameter details 2017-10-27 15:46:34 -07:00
module Fix more cstyle warnings 2018-02-24 10:05:37 -08:00
rpm Exclude python scripts from RPM shebang check 2018-04-16 15:40:14 -07:00
scripts Fix spl check.sh script 2016-09-14 17:17:00 -07:00
.gitignore Improve gitignore 2017-05-25 10:12:50 -07:00
AUTHORS Refresh AUTHORS 2012-12-19 09:40:18 -08:00
COPYING Public Release Prep 2010-05-17 15:18:00 -07:00
DISCLAIMER Public Release Prep 2010-05-17 15:18:00 -07:00
META Tag spl-0.7.0 2017-07-26 10:12:04 -07:00
Makefile.am Add DKMS package on Debian-based distributions 2017-10-15 12:58:12 -07:00
README.markdown Update README: run autogen first 2018-05-07 10:12:25 -07:00
autogen.sh build: do not call boilerplate ourself 2013-04-02 11:08:46 -07:00
configure.ac Fix undefined RPM macros 2018-05-02 15:34:20 -07:00
copy-builtin Ensure spl/ only occurs once in core-y 2016-01-26 11:54:24 -08:00
spl.release.in Move spl.release generation to configure step 2012-07-12 12:13:47 -07:00

README.markdown

The Solaris Porting Layer (SPL) is a Linux kernel module which provides many of the Solaris kernel APIs. This shim layer makes it possible to run Solaris kernel code in the Linux kernel with relatively minimal modification. This can be particularly useful when you want to track upstream Solaris development closely and do not want the overhead of maintaining a large patch which converts Solaris primitives to Linux primitives.

To build packages for your distribution:

$ sh autogen.sh
$ ./configure
$ make pkg

If you are building directly from the git tree and not an officially released tarball you will need to generate the configure script. This can be done by executing the autogen.sh script after installing the GNU autotools for your distribution.

To copy the kernel code inside your kernel source tree for builtin compilation:

$ sh autogen.sh
$ ./configure --enable-linux-builtin --with-linux=/usr/src/linux-...
$ ./copy-builtin /usr/src/linux-...

The SPL comes with an automated test suite called SPLAT. The test suite is implemented in two parts. There is a kernel module which contains the tests and a user space utility which controls which tests are run. To run the full test suite:

$ sudo insmod ./module/splat/splat.ko
$ sudo ./cmd/splat --all

Full documentation for building, configuring, testing, and using the SPL can be found at: http://zfsonlinux.org