1 files changed, 20 insertions, 1 deletions
diff --git a/doc/index.txt b/doc/index.txt
index 135e734..dbb37b7 100644
--- a/doc/index.txt
+++ b/doc/index.txt
@@ -99,7 +99,7 @@ Some submodules have further documentation, appearing later in this document.
 <table border=1>
 <tr><td>Name</td><td>Flag</td><td>Options</td><td>Description</td></tr>
 <tr><td>stdout_printer</td><td>-o</td><td>(None)</td><td>Prints records to standard out. You should probably redirect the output to a file when you use this.</td></tr>
-<tr><td>visualizer</td><td>-v</td><td>(None)</td><td>Visualizes records. You should probably use filters in conjunction with this submodule. Otherwise, it'll take forever to render, and do you _really_ want to visualize the _entire_ trace, anyway?</td></tr>
+<tr><td>visualizer</td><td>-v</td><td>(None)</td><td>Visualizes records. You should probably use filters in conjunction with this submodule. Otherwise, it'll take forever to render, and do you <i>really</i> want to visualize the <i>entire</i> trace, anyway?</td></tr>
 <tr><td>gedf_inversion_stat_printer</td><td>-i</td><td>number n</td><td>Outputs statistics about G-EDF inversions, and the n longest inversions. (You can specify n as 0 if you want.)</td></tr>
 </table>
 ### Miscellaneous Submodules ###
@@ -114,6 +114,25 @@ Here, documentation is provided for submodules for which relevant information is
 (So far, it hasn't been necessary to add anything here, but once questions arise, it will become clear which submodules need to be documented more fully.)
+## Gotchas ##
+Here, documentation is provided for potentially confusing topics that are not documented elsewhere.
+### A Note on Time ###
+In general, Unit-Trace is agnostic about the units of time used in the trace files.
+This is not expected to change in the future.
+The exception is output modules.
+Currently, some output modules assume time is in nanoseconds; they convert it into milliseconds and print the 'ms' unit indicator, where convenient.
+This behavior may have to be modified in the future if non-nanosecond trace files are used.
+## Known Bugs ##
+Here, documentation of known bugs is provided.
+(No known bugs right now --- but we are CERTAIN that there are some hiding...)
 ## Development ##
 Please send patches to [Mac Mollison][mac] or, if you are in the `litmus` group at UNC, just work with the git repo directly.

diff --git a/doc/index.txt b/doc/index.txt index 135e734..dbb37b7 100644 --- a/doc/index.txt +++ b/doc/index.txt
@@ -99,7 +99,7 @@ Some submodules have further documentation, appearing later in this document.
99	<table border=1>	99	<table border=1>
100	<tr><td>Name</td><td>Flag</td><td>Options</td><td>Description</td></tr>	100	<tr><td>Name</td><td>Flag</td><td>Options</td><td>Description</td></tr>
101	<tr><td>stdout_printer</td><td>-o</td><td>(None)</td><td>Prints records to standard out. You should probably redirect the output to a file when you use this.</td></tr>	101	<tr><td>stdout_printer</td><td>-o</td><td>(None)</td><td>Prints records to standard out. You should probably redirect the output to a file when you use this.</td></tr>
102	<tr><td>visualizer</td><td>-v</td><td>(None)</td><td>Visualizes records. You should probably use filters in conjunction with this submodule. Otherwise, it'll take forever to render, and do you _really_ want to visualize the _entire_ trace, anyway?</td></tr>	102	<tr><td>visualizer</td><td>-v</td><td>(None)</td><td>Visualizes records. You should probably use filters in conjunction with this submodule. Otherwise, it'll take forever to render, and do you <i>really</i> want to visualize the <i>entire</i> trace, anyway?</td></tr>
103	<tr><td>gedf_inversion_stat_printer</td><td>-i</td><td>number n</td><td>Outputs statistics about G-EDF inversions, and the n longest inversions. (You can specify n as 0 if you want.)</td></tr>	103	<tr><td>gedf_inversion_stat_printer</td><td>-i</td><td>number n</td><td>Outputs statistics about G-EDF inversions, and the n longest inversions. (You can specify n as 0 if you want.)</td></tr>
104	</table>	104	</table>
105	### Miscellaneous Submodules ###	105	### Miscellaneous Submodules ###
@@ -114,6 +114,25 @@ Here, documentation is provided for submodules for which relevant information is
114		114
115	(So far, it hasn't been necessary to add anything here, but once questions arise, it will become clear which submodules need to be documented more fully.)	115	(So far, it hasn't been necessary to add anything here, but once questions arise, it will become clear which submodules need to be documented more fully.)
116		116
		117	## Gotchas ##
		118
		119	Here, documentation is provided for potentially confusing topics that are not documented elsewhere.
		120
		121	### A Note on Time ###
		122
		123	In general, Unit-Trace is agnostic about the units of time used in the trace files.
		124	This is not expected to change in the future.
		125	The exception is output modules.
		126	Currently, some output modules assume time is in nanoseconds; they convert it into milliseconds and print the 'ms' unit indicator, where convenient.
		127	This behavior may have to be modified in the future if non-nanosecond trace files are used.
		128
		129	## Known Bugs ##
		130
		131	Here, documentation of known bugs is provided.
		132
		133	(No known bugs right now --- but we are CERTAIN that there are some hiding...)
		134
		135
117	## Development ##	136	## Development ##
118	Please send patches to [Mac Mollison][mac] or, if you are in the `litmus` group at UNC, just work with the git repo directly.	137	Please send patches to [Mac Mollison][mac] or, if you are in the `litmus` group at UNC, just work with the git repo directly.
119		138