[mirror_spl-debian.git] / 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:

    $ ./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:

    $ ./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>
Commit	Line	Data
33a20369 LG	1	The Solaris Porting Layer (SPL) is a Linux kernel module which provides
	2	many of the Solaris kernel APIs. This shim layer makes it possible to
	3	run Solaris kernel code in the Linux kernel with relatively minimal
	4	modification. This can be particularly useful when you want to track
	5	upstream Solaris development closely and do not want the overhead of
	6	maintaining a large patch which converts Solaris primitives to Linux
	7	primitives.
	8
	9	To build packages for your distribution:
	10
	11	$ ./configure
	12	$ make pkg
	13
	14	If you are building directly from the git tree and not an officially
	15	released tarball you will need to generate the configure script.
	16	This can be done by executing the autogen.sh script after installing
	17	the GNU autotools for your distribution.
	18
	19	To copy the kernel code inside your kernel source tree for builtin
	20	compilation:
	21
	22	$ ./configure --enable-linux-builtin --with-linux=/usr/src/linux-...
	23	$ ./copy-builtin /usr/src/linux-...
	24
	25	The SPL comes with an automated test suite called SPLAT. The test suite
	26	is implemented in two parts. There is a kernel module which contains
	27	the tests and a user space utility which controls which tests are run.
	28	To run the full test suite:
	29
	30	$ sudo insmod ./module/splat/splat.ko
	31	$ sudo ./cmd/splat --all
	32
	33	Full documentation for building, configuring, testing, and using the
	34	SPL can be found at: <http://zfsonlinux.org>