]> git.ipfire.org Git - thirdparty/valgrind.git/commitdiff
Relax the requirement that a pub_tool_<modulename>.h file must exist
authorJulian Seward <jseward@acm.org>
Sun, 24 Apr 2005 14:34:42 +0000 (14:34 +0000)
committerJulian Seward <jseward@acm.org>
Sun, 24 Apr 2005 14:34:42 +0000 (14:34 +0000)
even if it defines nothing.  That's a bit silly.

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

coregrind/README_MODULES.txt

index 7b9490b2621121e4533e24005f933897b4058a5d..9c6ee01993bf3936872b7f4740b79608b3310b6b 100644 (file)
@@ -34,15 +34,14 @@ its public (exported) interface:
   coregrind/pub_core_foo.h
 
 pub_tool_foo.h describes that part of the module's functionality that
-is visible to tools.  Hopefully this can be minimal or zero.  The file
-must still exist even if it defines nothing.
+is visible to tools.  Hopefully this can be minimal or zero.  If there
+is nothing to visible to tool, pub_tool_foo.h can be omitted.
 
 pub_core_foo.h describes functionality that is visible to other
 modules in the core.  This is a strict superset of the visible-to-tool
-functionality.
-
-Consequently, pub_core_foo.h may #include pub_tool_foo.h, but not the
-other way round.
+functionality.  Consequently, pub_core_foo.h *must* #include
+pub_tool_foo.h, if it exists.  pub_tool_foo.h *must not* #include
+pub_core_foo.h, nor any other pub_core_ header for that matter.
 
 No module may include the private headers of any other module.  If a
 type/enum/function/struct/whatever is stated in neither