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

35 lines
1.3 KiB
Markdown
Raw Normal View History

Add basic README A simple README with a short summary of the project and a link directing people to the online documentation.
2010-06-29 21:13:07 +00:00
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
Improve build instructions Make it clear that when building directly from the Git tree the configure script must be manually generated by running the autogen.sh script. This requires that the GNU autotools packages be installed for your distribution. Signed-off-by: Brian Behlendorf <behlendorf1@llnl.gov> Closes zfsonlinux/zfs#1448
2013-07-11 23:07:15 +00:00
upstream Solaris development closely and do not want the overhead of
Add basic README A simple README with a short summary of the project and a link directing people to the online documentation.
2010-06-29 21:13:07 +00:00
maintaining a large patch which converts Solaris primitives to Linux
primitives.
Add quick build instructions Full update to date build information will stay on the wiki for now, but there is no harm in adding the bare bones instructions to the README. They shouldn't change and are a reasonable quick start.
2010-09-01 17:23:05 +00:00
To build packages for your distribution:
Fix markdown rendering These two lines were being rendered incorrectly on the GitHub site. To fix the issue there needs to be leading whitespace before each line to ensure each command is rendered on its own line. $ ./configure $ make pkg
2010-09-15 16:05:34 +00:00
$ ./configure
$ make pkg
Add quick build instructions Full update to date build information will stay on the wiki for now, but there is no harm in adding the bare bones instructions to the README. They shouldn't change and are a reasonable quick start.
2010-09-01 17:23:05 +00:00
Improve build instructions Make it clear that when building directly from the Git tree the configure script must be manually generated by running the autogen.sh script. This requires that the GNU autotools packages be installed for your distribution. Signed-off-by: Brian Behlendorf <behlendorf1@llnl.gov> Closes zfsonlinux/zfs#1448
2013-07-11 23:07:15 +00:00
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.
Add script for builtin module building. This commit introduces a "copy-builtin" script designed to prepare a kernel source tree for building SPL as a builtin module. The script makes a full copy of all needed files, thus making the kernel source tree fully independent of the spl source package. To achieve that, some compilation flags (-include, -I) have been moved to module/Makefile. This Makefile is only used when compiling external modules; when compiling builtin modules, a Kbuild file generated by the configure-builtin script is used instead. This makes sure Makefiles inside the kernel source tree does not contain references to the spl source package. Signed-off-by: Brian Behlendorf <behlendorf1@llnl.gov> Issue zfsonlinux/zfs#851
2012-07-09 09:10:31 +00:00
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-...
Document how to run SPLAT Signed-off-by: Brian Behlendorf <behlendorf1@llnl.gov> Closes #294
2013-09-22 16:45:54 +00:00
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>