vendor/dtracetoolkit/dtracetoolkit-20120512vendor/dtracetoolkit

1 files changed, 21 insertions, 0 deletions

diff --git a/Docs/Readme b/Docs/Readme
new file mode 100644
index 000000000000..1f98f38d30f1
--- /dev/null
+++ b/Docs/Readme
@@ -0,0 +1,21 @@
+Docs - DTraceToolkit Documentation
+
+   Docs/Contents	summary of toolkit commands
+   Examples		examples of command usage
+   Notes		notes on commands
+
+The following may be followed to learn about a DTraceToolkit command,
+
+	1. read "Contents" for a command name and toolkit location.
+	2. run the command with "-h" to check it's usage.
+	3. read the manpage from Man/man1m.
+	4. read the examples from Examples.
+	5. read the notes from Notes.
+	6. read the script itself
+
+Try the following to discover all docs related to a command, eg iosnoop,
+
+	find . | grep iosnoop
+
+best run from the DTraceToolkit root directory.
+