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