Add dataflowAPI/src/RegisterMap.C

dyninst · Apr 3, 2024 · 7ad9369 · 7ad9369
1 parent 9eda5ee
commit 7ad9369
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/dataflowAPI/src/RegisterMap.C b/dataflowAPI/src/RegisterMap.C
@@ -31,10 +31,6 @@
 #include "dataflowAPI/src/RegisterMap.h"
 #include "dyn_regs.h"
 
-// We use the singleton approach, rather than static construction, to ensure the
-// register maps are created correctly. In at least one case (Ubuntu 12.04) they
-// weren't.
-
 namespace Dyninst {
 namespace DataflowAPI {
 

diff --git a/docs/dataflowAPI/developer/RegisterMap.h.rst b/docs/dataflowAPI/developer/RegisterMap.h.rst
@@ -10,3 +10,9 @@ RegisterMap.h
 .. cpp:function:: RegisterMap &machRegIndex_ppc()
 .. cpp:function:: RegisterMap &machRegIndex_ppc_64()
 .. cpp:function:: RegisterMap &machRegIndex_aarch64()
+
+Notes
+*****
+
+We use the singleton approach, rather than static construction, to ensure the
+register maps are created correctly. In at least one case (Ubuntu 12.04) they weren't.