Skip to content

Commit

Permalink
chrisa#99 Document some obstacles when using OS X or FreeBSD
Browse files Browse the repository at this point in the history
  • Loading branch information
melloc committed Jun 12, 2017
1 parent dbc47c8 commit 8bbfc9a
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,8 +152,19 @@ supported by this module. See libusdt's status at:

https://github.com/chrisa/libusdt#readme

FreeBSD is supported in principle but is restricted to only 4 working
arguments per probe.
When using Mac OS X, be aware that as of 10.11 (El Capitan), DTrace use
is restricted, and you'll probably want to
[disable SIP](http://internals.exposed/blog/dtrace-vs-sip.html) to
effectively use DTrace.

FreeBSD 10 and 11 are also supported, but you'll need to make sure that
you have the DTrace headers installed in /usr/src otherwise libusdt
won't be able to compile. You can
[clone them using SVN](https://www.freebsd.org/doc/handbook/svn.html),
or find the correct `src.txz`
[here](ftp://ftp.freebsd.org/pub/FreeBSD/releases/) and extract that.
Also note that FreeBSD 10 is restricted to only 4 working arguments per
probe.

Platforms not supporting DTrace (notably, Linux and Windows) may
install this module without building libusdt, with a stub no-op
Expand Down

0 comments on commit 8bbfc9a

Please sign in to comment.