mirror_zfs/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 don’t want the overhead of
maintaining a large patch which converts Solaris primitives to Linux
primitives.

To build packages for your distribution:

    $ ./configure
    $ make pkg

Full documentation for building, configuring, and using the SPL can
be found at: <http://zfsonlinux.org>
-												Add basic README

A simple README with a short summary of the project and a link
directing people to the online documentation.

											
										
										
											2010-06-30 01:13:07 +04: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
 								upstream Solaris development closely and don’t want the overhead of
 								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 21:23:05 +04: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 20:05:34 +04: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 21:23:05 +04:00
 								Full documentation for building, configuring, and using the SPL can
-												Reference new zfsonlinux.org website

The wiki contents have been converted to html and made available
at their new home http://zfsonlinux.org.  The wiki has also been
disabled the html pages are now the official documentation.

											
										
										
											2010-09-15 02:54:15 +04:00
+								be found at: <http://zfsonlinux.org>