From 8bbfc9aa1fab502cbb75be17436cc2732aa7efd2 Mon Sep 17 00:00:00 2001 From: Cody Peter Mello Date: Mon, 12 Jun 2017 22:52:42 +0000 Subject: [PATCH] chrisa/node-dtrace-provider#99 Document some obstacles when using OS X or FreeBSD --- README.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8733438..88b750e 100644 --- a/README.md +++ b/README.md @@ -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