search

openzfs / spl

A shim layer which adds the core interfaces required for OpenZFS.
https://zfsonlinux.org/
GNU General Public License v2.0
282 stars 181 forks source link

Update README: run autogen first #704

Closed ahrens closed 6 years ago

ahrens commented 6 years ago

Now I realize that the README does cover this in the next paragraph: 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.

It seems like the instructions are coming from the point of view of building packages from an "officially released tarball". I wonder if that should be the primary audience here, vs. folks that want to compile SPL from the source on github (so that they can compile ZFS from the source on github). For example, make pkg is insufficient to build what zfs needs (Module.symvers, for example). Instead you would want to run make.

behlendorf commented 6 years ago

Yes, the expected audience was primarily users building from the tarballs. However, enough people have been tripped up by this exact thing that I think it's reasonable to list it explicitly. It's not harmful to those building from released tarballs and it does avoid one potential problem.

make pkg

This should be sufficient, but you do need to install the resulting development packages. That unfortunately isn't clearly explained in the README. We are working to updated wiki documentation to make this more clear.