xref: /netbsd-src/external/cddl/dtracetoolkit/dist/Docs/Notes/Readme (revision c29d51755812ace2e87aeefdb06cb2b4dac7087a)
1*c29d5175SchristosNotes - Discussion about tools and their output
2*c29d5175Schristos
3*c29d5175Schristos   This directory contains files that provide deeper discussions about
4*c29d5175Schristos   tools and their output.
5*c29d5175Schristos
6*c29d5175Schristos   Files are either named,
7*c29d5175Schristos
8*c29d5175Schristos	ALL*_notes.txt	- notes that cover a collection of tools
9*c29d5175Schristos	*_notes.txt	- notes that cover a specific tool
10*c29d5175Schristos
11*c29d5175Schristos   These files are exist as an informal place to dump "stuff". This might
12*c29d5175Schristos   range from caveats to bear in mind when interpreting tool output, to
13*c29d5175Schristos   general or bizzare knowledge. Tool documentation is placed in,
14*c29d5175Schristos
15*c29d5175Schristos	/Man		- formal man pages
16*c29d5175Schristos	/Examples	- demos and how to read the output
17*c29d5175Schristos	*.d		- implementation notes within the code itself
18*c29d5175Schristos	/Notes		- everything else
19*c29d5175Schristos
20*c29d5175Schristos   Many of the scripts and man pages refer to files in this directory.
21*c29d5175Schristos
22