From: Andreas Sandberg <Andreas.Sandberg@ARM.com>
Date: Fri, 15 Feb 2013 22:40:10 +0000 (-0500)
Subject: cpu: Document exec trace flags
X-Git-Tag: stable_2013_06_16~109
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=3af59ab386ba297b99d2a215f4c5efa10d0cfe56;p=gem5.git

cpu: Document exec trace flags
---

diff --git a/src/cpu/SConscript b/src/cpu/SConscript
index 913e58a8e..c52dbc53b 100644
--- a/src/cpu/SConscript
+++ b/src/cpu/SConscript
@@ -135,23 +135,23 @@ DebugFlag('Commit')
 DebugFlag('Context')
 DebugFlag('Decode')
 DebugFlag('DynInst')
-DebugFlag('ExecEnable')
-DebugFlag('ExecCPSeq')
-DebugFlag('ExecEffAddr')
+DebugFlag('ExecEnable', 'Filter: Enable exec tracing (no tracing without this)')
+DebugFlag('ExecCPSeq', 'Format: Instruction sequence number')
+DebugFlag('ExecEffAddr', 'Format: Include effective address')
 DebugFlag('ExecFaulting', 'Trace faulting instructions')
-DebugFlag('ExecFetchSeq')
-DebugFlag('ExecOpClass')
+DebugFlag('ExecFetchSeq', 'Format: Fetch sequence number')
+DebugFlag('ExecOpClass', 'Format: Include operand class')
 DebugFlag('ExecRegDelta')
-DebugFlag('ExecResult')
-DebugFlag('ExecSpeculative')
-DebugFlag('ExecSymbol')
-DebugFlag('ExecThread')
-DebugFlag('ExecTicks')
-DebugFlag('ExecMicro')
-DebugFlag('ExecMacro')
-DebugFlag('ExecUser')
-DebugFlag('ExecKernel')
-DebugFlag('ExecAsid')
+DebugFlag('ExecResult', 'Format: Include results from execution')
+DebugFlag('ExecSpeculative', 'Format: Include a miss-/speculation flag (-/+)')
+DebugFlag('ExecSymbol', 'Format: Try to include symbol names')
+DebugFlag('ExecThread', 'Format: Include thread ID in trace')
+DebugFlag('ExecTicks', 'Format: Include tick count')
+DebugFlag('ExecMicro', 'Filter: Include microops')
+DebugFlag('ExecMacro', 'Filter: Include macroops')
+DebugFlag('ExecUser', 'Filter: Trace user mode instructions')
+DebugFlag('ExecKernel', 'Filter: Trace kernel mode instructions')
+DebugFlag('ExecAsid', 'Format: Include ASID in trace')
 DebugFlag('Fetch')
 DebugFlag('IntrControl')
 DebugFlag('O3PipeView')