Tweaked comment.

git-svn-id: svn://svn.valgrind.org/valgrind/trunk@2655

diff --git a/coregrind/core.h b/coregrind/core.h
index 85313afb56334e838fdd18f2374ceaa4e014f2b6..2811a55218db77c969bd8a830cc31a94a43b0dc7 100644 (file)
--- a/coregrind/core.h
+++ b/coregrind/core.h
@@ -49,19 +49,24 @@
       - C headers        include  asm headers
 
      This gives the following hierarchy (only showing 'arch' headers, not
-     'os' or 'platform' headers), where arrows indicate inclusion:
-
-        (tool_arch_asm.h?) <------- core_arch_asm.h
-            ^     ^                    ^     ^
-           /       \                  /       \
-          /         \                /         \
-      tool_asm.h <---\---------- core_asm.h     \
-          ^           \              ^           \
-           \    tool_arch.h <---------\---- core_arch.h
-            \         ^                \         ^
-             \       /                  \       /
-              \     /                    \     /
-              tool.h <------------------ core.h
+     'os' or 'platform' headers), where arrows indicate inclusion, and
+     $VG_ARCH==x86:
+
+
+   (include/x86/tool_arch_asm.h?) <----- coregrind/x86/core_arch_asm.h
+              ^   ^                          ^   ^
+             /     \                        /     \
+            /       \                      /       \
+           /         \                    /         \
+ include/tool_asm.h <-\---- coregrind/core_asm.h     \
+           ^           \                  ^           \
+            \  include/x86/tool_arch.h <--------coregrind/x86/core_arch.h
+             \         ^                    \         ^
+              \       /                      \       /
+               \     /                        \     /
+                \   /                          \   /
+           include/tool.h <------------ coregrind/core.h
+
 
    Note that core.h contains the *declarations* of arch-specific functions
    and variables, which can be used by the core_arch.h file of any
@@ -69,6 +74,9 @@
    However, arch-specific macros and types cannot go into core.h, because
    there is no separation between declaration and definition for
    macros/types, so they instead go into $VG_ARCH/core_arch.h.
+
+   The tool-specific headers are all in include/ so they can be seen by any
+   external tools.
 */